gitlab-triage 1.6.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 403aa273677c675e590d5c2a46c0feb1d5087e1369532cb7c3b063e79191bc8c
-  data.tar.gz: 2f25cbdcad4c7b8ddd861d026711e396d8c1f9cc01f489a65166954694bc344c
+  metadata.gz: 9ac5f595e5dffde9a3135eec982d931510615517b7512168291944252cd6f2ed
+  data.tar.gz: 3336902a5864b878ad60091442fd2047eeef620981ae4d8e40c73c0ca2394cb1
 SHA512:
-  metadata.gz: 27804c7a88c2079a8559593381e4aa6a0a94bbc6b0d5f23e4624227953fb75b57d177f79b86dbb09ee0836c2be0f9637ac7f762da80f955ae88294943cd1d6fa
-  data.tar.gz: 5ba384a4eb246540da8d23250240af00f4bdc30aa16e1dc17a1fbd4c294f3463e0a9cfefdce653d942ae738c7abc90ad55c28aff95f4c820247d027a18f2459b
+  metadata.gz: a5669015087540e47ea682b07a3282a7fbb49e3206cb635e71086fa180f82084908dc964c659d7faeca8e0a8cabe83a0b296e7835ea161f43c26887aa5066ec6
+  data.tar.gz: b6f348f4d5adf7e7685f97d10fdaf0545e0952a91ee74b0997cdcba10b7a0c0a9823ed14dde92188f749731fd7b870cc8700d3fbc7733128b219a51287504517

data/.gitignore

@@ -6,7 +6,6 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/.gitlab-ci.yml

@@ -1,49 +1,67 @@
-image: ruby:2.6
-
 stages:
   - prepare
   - test
   - triage
+  - release
 
-.default-only:
-  only:
-    refs:
-      - master
-      - merge_requests
-      - tags
-
-.default-before_script:
+default:
+  image: ruby:2.7
+  tags:
+    - gitlab-org
+  cache:
+    key:
+      files:
+        - Gemfile
+        - gitlab-triage.gemspec
+    paths:
+      - vendor/ruby
+      - Gemfile.lock
+    policy: pull
   before_script:
+    - ruby --version
     - gem install bundler --no-document --version 2.0.2
-    - bundle install --jobs $(nproc) --retry 3 --quiet
+    - bundle --version
+    - bundle install --jobs $(nproc) --path=vendor --retry 3 --quiet
+    - bundle check
+
+workflow:
+  rules:
+    # For merge requests, create a pipeline.
+    - if: '$CI_MERGE_REQUEST_IID'
+    # For `master` branch, create a pipeline (this includes on schedules, pushes, merges, etc.).
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
+    # For tags, create a pipeline.
+    - if: '$CI_COMMIT_TAG'
+
+.use-docker-in-docker:
+  image: docker:${DOCKER_VERSION}
+  services:
+    - docker:${DOCKER_VERSION}-dind
+  variables:
+    DOCKER_DRIVER: overlay2
+    DOCKER_HOST: tcp://docker:2375
+    DOCKER_TLS_CERTDIR: ""
+  tags:
+    # See https://gitlab.com/gitlab-com/www-gitlab-com/-/issues/7019 for tag descriptions
+    - gitlab-org-docker
 
 ###################
 ## Prepare stage ##
 ###################
 setup-test-env:
-  extends: .default-only
   stage: prepare
   script:
-    - ruby --version
-    - gem install bundler --no-document
-    - bundle --version
-    - bundle install --clean --jobs $(nproc) --path=vendor --retry=3 --quiet
-    - bundle check
+    - echo "Setup done!"
   cache:
-    key: "$CI_JOB_NAME-ruby-2.6"
-    paths:
-      - vendor/ruby
-      - Gemfile.lock
+    policy: pull-push
   artifacts:
     paths:
-      - vendor/ruby
       - Gemfile.lock
 
 ################
 ## Test stage ##
 ################
 rubocop:
-  extends: [".default-only", ".default-before_script"]
   stage: test
   needs: ["setup-test-env"]
   dependencies: ["setup-test-env"]
@@ -55,20 +73,15 @@ rubocop:
       - .cache/rubocop_cache/
 
 # We need to copy this job's definition from the Code-Quality.gitlab-ci.yml
-# template because `only` is set without `refs`, so it takes precedence over `.default-only`.
+# template because `only` is set without `refs`, so it takes precedence over default workflow rules.
 # See https://gitlab.com/gitlab-org/gitlab-ce/issues/66767.
 code_quality:
-  extends: .default-only
-  needs: ["setup-test-env"]
-  dependencies: ["setup-test-env"]
+  extends: .use-docker-in-docker
   stage: test
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   variables:
-    DOCKER_DRIVER: overlay2
     DOCKER_TLS_CERTDIR: ""
+  before_script: []
   script:
     - |
       if ! docker info &>/dev/null; then
@@ -85,14 +98,9 @@ code_quality:
     reports:
       codequality: gl-code-quality-report.json
     expire_in: 1 week
-  except:
-    variables:
-      - $CODE_QUALITY_DISABLED
 
 specs:
-  extends: [".default-only", ".default-before_script"]
   needs: ["setup-test-env"]
-  dependencies: ["setup-test-env"]
   stage: test
   script:
     - bundle exec rake spec
@@ -101,12 +109,13 @@ specs:
 ## Triage stage ##
 ##################
 dry-run:gitlab-triage:
-  extends: [".default-only", ".default-before_script"]
   needs: ["setup-test-env"]
-  dependencies: ["setup-test-env"]
   stage: triage
   script:
-    - bundle exec rake install:local
+    - bundle exec rake build
+    - gem install pkg/*.gem
+    - which gitlab-triage
+    - gitlab-triage --version
     - gitlab-triage --help
     - gitlab-triage --init
     - gitlab-triage --dry-run --debug --token $API_TOKEN --source-id $CI_PROJECT_PATH
@@ -114,4 +123,30 @@ dry-run:gitlab-triage:
 # This job requires allows to override the `CI_PROJECT_PATH` variable when triggered.
 dry-run:custom:
   extends: dry-run:gitlab-triage
-  when: manual
+  rules:
+    - when: manual
+      allow_failure: true
+
+###################
+## Release stage ##
+###################
+release:
+  stage: release
+  rules:
+    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_PIPELINE_SOURCE == "push"'
+      changes: ["lib/gitlab/triage/version.rb"]
+    - if: '$CI_MERGE_REQUEST_TITLE =~ /RELEASE/'
+      when: manual
+  before_script: []
+  script:
+    - version=$(ruby -r ./lib/gitlab/triage/version -e 'puts Gitlab::Triage::VERSION' | tr -d "\n")
+    - tag="v${version}"
+    - message="Version ${version}."
+    # TODO: Add release notes from the Release MR?
+    - 'curl --request POST --header "PRIVATE-TOKEN: ${API_TOKEN}" -d "tag_name=${tag}" -d "ref=${CI_COMMIT_SHA}" -d "message=${message}" "${CI_API_V4_URL}/projects/${CI_PROJECT_ID}/repository/tags"'
+    - gem build gitlab-triage.gemspec
+    - gem push "gitlab-triage-${version}.gem"
+  artifacts:
+    paths:
+      - gitlab-triage*.gem
+    expire_in: 30 days

data/.gitlab/merge_request_templates/Release.md

@@ -0,0 +1,35 @@
+<!-- Replace `v4.5.0` with the previous release here, and `e18d76b309e42888759c1effe96767f13e34ae55`
+with the latest commit from https://gitlab.com/gitlab-org/gitlab-triage/commits/master that will be included in the release. -->
+- Diff: https://gitlab.com/gitlab-org/gitlab-triage/compare/v4.5.0...e18d76b309e42888759c1effe96767f13e34ae55
+
+- Release notes:
+
+<!-- Keep the sections order but remove the empty sections -->
+
+```markdown
+### New scenarios and scenario updates
+
+- !aaa <Title of the aaa MR>.
+
+### Fixes
+
+- !bbb <Title of the bbb MR>.
+
+### Doc changes
+
+- !ccc <Title of the ccc MR>.
+
+### Other changes (CI, backstage)
+
+- !ddd <Title of the ddd MR>.
+```
+
+- Checklist before merging:
+  - [ ] Diff link is up-to-date.
+  - [ ] Based on the diff, `lib/gitlab/triage/version.rb` is updated, according to [SemVer](https://semver.org).
+  - [ ] Release notes are accurate.
+
+- Checklist after merging:
+  - [ ] [Update the release notes for the newly created tag](docs/release_process.md#how-to).
+
+/label ~"Engineering Productivity" ~"ep::triage" ~"tooling::workflow"

data/.rubocop.yml

@@ -11,3 +11,6 @@ AllCops:
 
 Rails/Output:
   Enabled: false
+
+Metrics/LineLength:
+  Max: 152

data/Gemfile

@@ -4,5 +4,5 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'gitlab-styles', '~> 3.0'
+  gem 'gitlab-styles', '~> 3.3.0'
 end

data/README.md

@@ -2,7 +2,7 @@
 
 # GitLab Triage Project
 
-This project contains the library and pipeline definition to enable automated triaging of issues in the [GitLab Project](https://gitlab.com/gitlab-org/gitlab).
+This project allows to automate triaging of issues and merge requests for GitLab projects or groups.
 
 ## gitlab-triage gem
 
@@ -58,7 +58,7 @@ resource_rules:
             interval: 5
           state: opened
           labels:
-            - No Label
+            - None
         limits:
           most_recent: 50
         actions:
@@ -66,6 +66,7 @@ resource_rules:
             - needs attention
           mention:
             - markglenfletcher
+          move: gitlab-org/backlog
           comment: |
             {{author}} This issue is unlabelled after 5 days. It needs attention. Please take care of this before the end of #{2.days.from_now.strftime('%Y-%m-%d')}
           summarize:
@@ -85,9 +86,27 @@ resource_rules:
               /label ~"needs attention"
   merge_requests:
     rules:
-      []
+      - name: My policy
+        conditions:
+          state: opened
+          labels:
+            - None
+        limits:
+          most_recent: 50
+        actions:
+          labels:
+            - needs attention
+          comment_type: thread
+          comment: |
+            {{author}} This issue is unlabelled. Please add one or more labels.
 ```
 
+### Real world example
+
+We're enforcing multiple polices with pipeline schedules at [triage-ops](
+https://gitlab.com/gitlab-org/quality/triage-ops), where we're also
+extensively utilizing the [plugins system](#can-i-customize).
+
 ### Fields
 
 A policy consists of the following fields:
@@ -210,6 +229,22 @@ conditions:
     - feature proposal
 ```
 
+###### Predefined special label names
+
+Basing on the [issues API](https://docs.gitlab.com/ee/api/issues.html), there
+are two special predefined label names we can use here:
+
+* `None`: This indicates that no labels were present
+* `Any`: This indicates that any labels were presented
+
+Example:
+
+```yml
+conditions:
+  labels:
+    - None
+```
+
 ###### Labels brace expansion
 
 We could expand the labels by using brace expansion, which is a pattern
@@ -506,7 +541,9 @@ Available action types:
 - [`remove_labels` action](#remove-labels-action)
 - [`status` action](#status-action)
 - [`mention` action](#mention-action)
+- [`move` action](#move-action)
 - [`comment` action](#comment-action)
+- [`comment_type` action option](#comment-type-action-option)
 - [`summarize` action](#summarize-action)
 
 ##### Labels action
@@ -572,6 +609,19 @@ actions:
     - markglenfletcher
 ```
 
+##### Move action
+
+Moves an issue (merge request is not supported yet) to the specified project.
+
+Accepts a string containing the target project path.
+
+Example:
+
+```yml
+actions:
+  move: target/project_path
+```
+
 ##### Comment action
 
 Adds a comment to the resource.
@@ -619,6 +669,26 @@ actions:
     {{author}} Are you still interested in finishing this merge request?
 ```
 
+##### Comment type action option
+
+Determines the type of comment to be added to the resource.
+
+The following comment types are supported:
+
+- `comment` (default): creates a regular comment on the resource
+- `thread`: starts a resolvable thread (discussion) on the resource
+
+For merge requests, if `comment_type` is set to `thread`, we can also configure that [all threads should be resolved before merging](https://docs.gitlab.com/ee/user/discussions/#only-allow-merge-requests-to-be-merged-if-all-threads-are-resolved), therefore this comment can prevent it from merging.
+
+Example:
+
+```yml
+actions:
+  comment_type: thread
+  comment: |
+    {{author}} Are you still interested in finishing this merge request?
+```
+
 ###### Harnessing Quick Actions
 
 [GitLab's quick actions feature](https://docs.gitlab.com/ce/user/project/quick_actions.html) is available in Core.
@@ -839,7 +909,7 @@ Which could generate an issue like:
 
 Here's a list of currently available Ruby expression API:
 
-##### API
+##### Methods for `Issue` and `MergeRequest` (the context)
 
 | Name                    | Return type     | Description |
 | ----                    | ----            | ----        |
@@ -851,6 +921,14 @@ Here's a list of currently available Ruby expression API:
 | labels_chronologically  | [Label]         | Same as `labels_with_details` but sorted chronologically |
 | label_events            | [LabelEvent]    | A list of label events on the resource |
 | instance_version        | InstanceVersion | The version for the GitLab instance we're triaging with |
+| project_path            | String          | The path with namespace to the issues or merge requests project |
+| full_resource_reference | String          | A full reference incuding project path to the issue or merge request |
+
+##### Methods for `MergeRequest` (merge request context)
+
+| Method              | Return type | Description |
+| ----                | ----        | ----        |
+| first_contribution? | Boolean     | `true` if it's the author's first contribution to the project; `false` otherwise. This API requires an additional API request for the merge request, thus would be slower. |
 
 ##### Methods for `Milestone`
 
@@ -928,6 +1006,7 @@ Usage: gitlab-triage [options]
     -r, --require [string]           Require a file before performing
     -d, --debug                      Print debug information
     -h, --help                       Print help message
+        --all-projects               Process all projects visible to `--token`
         --init                       Initialize the project with a policy file
         --init-ci                    Initialize the project with a .gitlab-ci.yml file
 ```
@@ -946,6 +1025,14 @@ Triaging against a whole group:
 gitlab-triage --dry-run --token $API_TOKEN --source-id gitlab-org --source groups
 ```
 
+Triaging against an entire instance:
+
+```
+gitlab-triage --dry-run --token $API_TOKEN --all-projects
+```
+
+> **Note:** The `--all-projects` option will process all resources for all projects visible to the specified `$API_TOKEN`
+
 #### Running on GitLab CI pipeline
 
 You can enforce policies using a scheduled pipeline:
@@ -1028,3 +1115,7 @@ resource_rules:
 ### Contributing
 
 Please refer to the [Contributing Guide](CONTRIBUTING.md).
+
+## Release Process
+
+Please refer to the [Release Process](docs/release_process.md).

data/gitlab-triage.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
-    f.match(%r{^(test|spec|features)/})
+    f.match(%r{^(docs|test|spec|features)/})
   end
   spec.bindir        = 'bin'
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }

data/lib/gitlab/triage/action/comment.rb

@@ -7,6 +7,7 @@ require_relative '../command_builders/label_command_builder'
 require_relative '../command_builders/remove_label_command_builder'
 require_relative '../command_builders/cc_command_builder'
 require_relative '../command_builders/status_command_builder'
+require_relative '../command_builders/move_command_builder'
 
 module Gitlab
   module Triage
@@ -43,6 +44,7 @@ module Gitlab
               CommandBuilders::LabelCommandBuilder.new(policy.actions[:labels]).build_command,
               CommandBuilders::RemoveLabelCommandBuilder.new(policy.actions[:remove_labels]).build_command,
               CommandBuilders::CcCommandBuilder.new(policy.actions[:mention]).build_command,
+              CommandBuilders::MoveCommandBuilder.new(policy.actions[:move]).build_command,
               CommandBuilders::StatusCommandBuilder.new(policy.actions[:status]).build_command
             ]
           ).build_command
@@ -61,13 +63,24 @@ module Gitlab
             source_id: resource[:project_id],
             resource_type: policy.type,
             resource_id: resource['iid'],
-            sub_resource_type: 'notes'
+            sub_resource_type: sub_resource_type
           ).build
 
           puts Gitlab::Triage::UI.debug "post_url: #{post_url}" if network.options.debug
 
           post_url
         end
+
+        def sub_resource_type
+          case type = policy.actions[:comment_type]
+          when 'comment', nil # nil is default
+            'notes'
+          when 'thread'
+            'discussions'
+          else
+            raise ArgumentError, "Unknown comment type: #{type}"
+          end
+        end
       end
     end
   end