gitlab-triage 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff9f08acbd7e13f681bff4673c63d450b283f70a30d19a5831556b3d99bc3b49
+  data.tar.gz: 7ef092df664c16f65aecaf34ef1983ea25c2a9b611c0fcd33be96c3188624bdb
+SHA512:
+  metadata.gz: 4587c4b294c332aab7d113d1925f0ee86512d02bcb8aabcaf59ad25f71674290ca361101094deb339a03f6e296ac0fd46142a6a1b5c548e6282efa2cedf68906
+  data.tar.gz: 786ad737d5891758591b4d78533b25f3aff7993c2a235e419603d8a5bcd01e18ae138514e7e73f7827126f6cf4ae94aa58225eb7b9029b8f7874aab8a36ed1a8

data/.codeclimate.yml

@@ -0,0 +1,19 @@
+---
+engines:
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+        - ruby
+  rubocop-gitlab:
+    enabled: true
+ratings:
+  paths:
+    - Gemfile.lock
+    - "**.rb"
+exclude_paths:
+  - spec/
+  - vendor/
+  - tmp/

data/.gitignore

@@ -0,0 +1,15 @@
+/.DS_Store
+/vendor/
+/.rspec
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.gitlab-ci.yml

@@ -0,0 +1,101 @@
+image: ruby:2.4
+
+stages:
+  - prepare
+  - test
+  - process_rules
+
+.default-cache-config: &default-cache-config
+  key: "ruby-2.4"
+  paths:
+    - vendor/cache/
+    - Gemfile.lock
+
+.pull-cache: &pull-cache
+  cache:
+    <<: *default-cache-config
+    policy: pull
+
+before_script:
+  - gem install bundler
+  - bundle --version
+  - bundle install --jobs $(nproc) --retry 3 --quiet
+
+setup-test-env:
+  stage: prepare
+  script:
+    - echo "All set!"
+  cache:
+    <<: *default-cache-config
+  artifacts:
+    paths:
+      - vendor/cache/
+      - Gemfile.lock
+
+styles:
+  stage: test
+  script:
+    - bundle exec rubocop
+  except:
+    - schedules
+  <<: *pull-cache
+
+specs:
+  stage: test
+  script:
+    - bundle exec rake spec
+  <<: *pull-cache
+
+build:
+  stage: test
+  script:
+    - bundle exec rake build
+    - bundle exec rake clobber
+  except:
+    - schedules
+  <<: *pull-cache
+
+codequality:
+  image: docker:latest
+  stage: test
+  variables:
+    DOCKER_DRIVER: overlay
+  services:
+    - docker:dind
+  before_script: []
+  script:
+    - docker run
+        --env CODECLIMATE_CODE="$PWD"
+        --volume "$PWD":/code
+        --volume /var/run/docker.sock:/var/run/docker.sock
+        --volume /tmp/cc:/tmp/cc
+        dev.gitlab.org:5005/gitlab/gitlab-build-images:gitlab-codeclimate
+        analyze -f json > raw_codeclimate.json
+    - cat raw_codeclimate.json | docker run -i stedolan/jq -c 'map({check_name,fingerprint,location})' > codeclimate.json
+  artifacts:
+    paths:
+      - codeclimate.json
+  except:
+      - schedules
+  <<: *pull-cache
+
+dry-run:triage:
+  stage: test
+  script:
+    - bundle exec bin/gitlab-triage --dry-run --token $API_TOKEN --policies-file policies.yml --project-id gitlab-org/triage
+  <<: *pull-cache
+
+dry-run:gilab-ce:
+  stage: process_rules
+  script:
+    - bundle exec bin/gitlab-triage --dry-run --token $API_TOKEN --policies-file policies.yml --project-id gitlab-org/gitlab-ce
+  when: manual
+  <<: *pull-cache
+
+results:
+  stage: process_rules
+  script:
+    - bundle exec bin/gitlab-triage --token $API_TOKEN --policies-file policies.yml --project-id gitlab-org/gitlab-ce
+  only:
+    - schedules
+  <<: *pull-cache

data/.gitlab/issue_templates/Policy.md

@@ -0,0 +1,32 @@
+### Policy title
+
+( add a title to accurately describe the policy that you are referring to )
+
+### New Policy/Policy Change/Policy Removal
+
+( declare the type of policy change this is )
+
+### Issues or Merge Requests Policy?
+
+Issues/Merge Requests/both
+
+### Policy Conditions
+
+( declare the conditions for the related policy )
+
+#### Example
+
+- Label: bug
+- not updated for over 6 months
+- no associated milestone (unscheduled)
+- state: open
+
+### Policy Actions
+
+( declare the actions for the related policy )
+
+#### Example
+
+- Add a comment
+- Mention @markglenfletcher
+- Label: "awaiting feedback" "auto updated"

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  gitlab-styles:
+    - rubocop-default.yml
+
+Rails/Output:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gitlab-rubocop.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,70 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+## Uncomment and set this to only include directories you want to watch
+# directories %w(app lib config test spec features) \
+#  .select{|d| Dir.exists?(d) ? d : UI.warning("Directory #{d} does not exist")}
+
+## Note: if you are using the `directories` clause above and you are not
+## watching the project directory ('.'), then you will want to move
+## the Guardfile to a watched dir and symlink it back, e.g.
+#
+#  $ mkdir config
+#  $ mv Guardfile config/
+#  $ ln -s config/Guardfile .
+#
+# and, you'll have to watch "config/Guardfile" instead of "Guardfile"
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separately)
+#  * 'just' rspec: 'rspec'
+
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # Feel free to open issues for suggestions and improvements
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+
+  # Rails files
+  rails = dsl.rails(view_extensions: %w[erb haml slim])
+  dsl.watch_spec_files_for(rails.app_files)
+  dsl.watch_spec_files_for(rails.views)
+
+  watch(rails.controllers) do |m|
+    [
+      rspec.spec.call("routing/#{m[1]}_routing"),
+      rspec.spec.call("controllers/#{m[1]}_controller"),
+      rspec.spec.call("acceptance/#{m[1]}")
+    ]
+  end
+
+  # Rails config changes
+  watch(rails.spec_helper)     { rspec.spec_dir }
+  watch(rails.routes)          { "#{rspec.spec_dir}/routing" }
+  watch(rails.app_controller)  { "#{rspec.spec_dir}/controllers" }
+
+  # Capybara features specs
+  watch(rails.view_dirs)     { |m| rspec.spec.call("features/#{m[1]}") }
+  watch(rails.layouts)       { |m| rspec.spec.call("features/#{m[1]}") }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$}) do |m|
+    Dir[File.join("**/#{m[1]}.feature")][0] || "spec/acceptance"
+  end
+end

data/README.md

@@ -0,0 +1,13 @@
+[![pipeline status](https://gitlab.com/gitlab-org/triage/badges/master/pipeline.svg)](https://gitlab.com/gitlab-org/triage/commits/master)
+
+## GitLab Triage Project
+
+This project contains scripts used for triaging Issues and Merge Requests in  [GitLab-CE Project](https://gitlab.com/gitlab-org/gitlab-ce) projects and enforcing our Issue Triage policies as well of generating data related to triaging issues more effectively.
+The scripts found here may be useful for triaging issues in other projects too.
+
+- We define the policies in code in a public project where those interested can raise issues surrounding our policies.
+- We use scheduled pipelines to run the scripts to enforce our policies on a daily basis.
+
+## Suggesting new policies or suggesting changes to policies
+
+Please feel free to [open an issue](https://gitlab.com/gitlab-org/triage/issues/new) about creating, editing or deleting a policy. Please select the policy issue template when creating an issue.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/gitlab-triage

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'yaml'
+require_relative '../lib/gitlab/triage/engine'
+
+Options = Struct.new(
+  :dry_run,
+  :policies_file,
+  :project_id,
+  :token,
+  :debug
+)
+
+class TriageOptionParser
+  class << self
+    def parse(argv)
+      options = Options.new
+
+      parser = OptionParser.new do |opts|
+        opts.banner = "Usage: #{__FILE__} [options]\n\n"
+
+        opts.on('-n', '--dry-run', "Don't actually update anything, just print") do |value|
+          options.dry_run = value
+        end
+
+        opts.on('-f', '--policies-file [string]', String, 'A valid policies YML file') do |value|
+          options.policies_file = value
+        end
+
+        opts.on('-p', '--project-id [string]', String, 'A project ID or path') do |value|
+          options.project_id = value
+        end
+
+        opts.on('-t', '--token [string]', String, 'A valid API token') do |value|
+          options.token = value
+        end
+
+        opts.on('-d', '--debug', 'Print debug information') do |value|
+          options.debug = value
+        end
+
+        opts.on('-h', '--help', 'Print help message') do
+          $stdout.puts opts
+          exit
+        end
+      end
+
+      parser.parse!(argv)
+
+      options
+    end
+  end
+end
+
+options = TriageOptionParser.parse(ARGV)
+
+policies_file = options.policies_file || '.triage-policies.yml'
+policies = HashWithIndifferentAccess.new(YAML.load_file(policies_file))
+
+Gitlab::Triage::Engine
+  .new(policies: policies, options: options)
+  .perform

data/gitlab-triage.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gitlab/triage/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gitlab-triage'
+  spec.version       = Gitlab::Triage::VERSION
+  spec.authors       = ['GitLab']
+  spec.email         = ['remy@rymai.me']
+
+  spec.summary       = 'GitLab triage automation project.'
+  spec.homepage      = 'https://gitlab.com/gitlab-org/triage'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 5.1'
+  spec.add_dependency 'httparty', '~> 0.15'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'gitlab-styles', '~> 2.1'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/gitlab/triage.rb

@@ -0,0 +1,6 @@
+require 'gitlab/triage/version'
+
+module Gitlab
+  module Triage
+  end
+end

data/lib/gitlab/triage/command_builders/base_command_builder.rb

@@ -0,0 +1,32 @@
+module Gitlab
+  module Triage
+    module CommandBuilders
+      class BaseCommandBuilder
+        def initialize(items)
+          @items = [items].flatten
+          @items.delete('')
+        end
+
+        def build_command
+          if @items.any?
+            [slash_command_string, content_string].compact.join(separator)
+          else
+            ""
+          end
+        end
+
+        private
+
+        def separator
+          ' '
+        end
+
+        def content_string
+          @items.map do |item|
+            format_item(item)
+          end.join(separator)
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/command_builders/cc_command_builder.rb

@@ -0,0 +1,19 @@
+require_relative 'base_command_builder'
+
+module Gitlab
+  module Triage
+    module CommandBuilders
+      class CcCommandBuilder < BaseCommandBuilder
+        private
+
+        def slash_command_string
+          "/cc"
+        end
+
+        def format_item(item)
+          "@#{item}"
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/triage/command_builders/comment_command_builder.rb

@@ -0,0 +1,23 @@
+require_relative 'base_command_builder'
+
+module Gitlab
+  module Triage
+    module CommandBuilders
+      class CommentCommandBuilder < BaseCommandBuilder
+        private
+
+        def separator
+          "\n\n"
+        end
+
+        def slash_command_string
+          nil
+        end
+
+        def format_item(item)
+          item
+        end
+      end
+    end
+  end
+end