gitlab-dangerfiles 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c22945b63f8eda2553d2324e3b309d1d2ae52634648325b20247e4888160abf
-  data.tar.gz: 4227fa40a95128828aae1a29bd1f777132644a875d9a633c360e7a5515bf521b
+  metadata.gz: 5d547fabe6901fa966c63b46205d60383a37876720750d659b1efc911f5ff5a9
+  data.tar.gz: c2acf1003771ac3e206388e51bd5c6c55df9aab6e554f122cdac7c55de446619
 SHA512:
-  metadata.gz: 3d3cda663afcc94f252d397c4b683a4143c0b60c758d279addbfe0816460962bc9679c0ce6424ae72e7829603eaf34ea3bffa3ad63c89facf6789dfc531a951d
-  data.tar.gz: 5df8ecd28fc500aaf2d61bb069c59461239f1e8f427211eac88a56fe68e105e8c0dfdc9b7d8371667c4e63e218c461052ac80341291f0074339f9affb3e886f7
+  metadata.gz: 8e8ea522c518333c74741b7c7f1fa9647117a2c181c05c2c6603a72e3ea0bc635e56dff1f5b8f0369d840f9adb55341571863f898cbc67d523ca6dbef6bc8603
+  data.tar.gz: 4ef5aa8b96aa69a98daec6bdc2f721aed505dd96c52f931e427269bd8f789b987273cc3be364746bdd26c00154da8a974883ac503c35e0b6edb701990f7ea48d

data/.gitlab/merge_request_templates/Release.md

@@ -7,7 +7,6 @@ with the latest commit from this merge request. -->
   - [ ] Based on the diff, `version.rb` is updated, according to [SemVer](https://semver.org).
 
 - Checklist after merging:
-  - [ ] [Update the release notes for the newly created tag](docs/release_process.md#how-to).
   - [ ] Check that automatic release notes (generated following the same process as https://docs.gitlab.com/ee/development/changelog.html) are correct.
 
 /label ~"type::maintenance" ~"static code analysis"

data/README.md

@@ -124,6 +124,29 @@ project. To use it in your project, perform the following steps:
    end
    ```
 
+### CI configuration
+
+In order to run `danger` on GitLab CI, perform the following steps:
+
+1. If not yet done, create a `Dangerfile` at the top-level of your project. Refer to [Usage](#usage) to
+   see how to set it up.
+2. In `.gitlab-ci.yml`, include [CI configuration](https://gitlab.com/gitlab-org/quality/pipeline-common/-/blob/master/ci/danger-review.yml)
+   which defines `danger-review` [CI job](https://docs.gitlab.com/ee/ci/jobs/):
+
+```yaml
+include:
+  - project: 'gitlab-org/quality/pipeline-common'
+    file:
+      - '/ci/danger-review.yml'
+```
+
+3. Create a [Project access token](https://docs.gitlab.com/ee/user/project/settings/project_access_tokens.html)
+   with scope `api` and role `Maintainer`.
+4. Add a [CI/CD variable](https://docs.gitlab.com/ee/ci/variables/#add-a-cicd-variable-to-a-project)
+   `DANGER_GITLAB_API_TOKEN` (`Masked` but not `Protected`) and use Project access token as value.
+
+See a [real world example](https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/105).
+
 ## Documentation
 
 Latest documentation can be found at <https://www.rubydoc.info/gems/gitlab-dangerfiles>.

data/lib/danger/plugins/internal/helper.rb

@@ -218,7 +218,7 @@ module Danger
     #
     # @return [Array<Symbol>] the categories a file is in, e.g., +[:frontend]+, +[:backend]+, or +%i[frontend tooling]+
     #   using filename regex (+filename_regex+) and specific change regex (+changes_regex+) from the given +categories+ hash.
-    def categories_for_file(filename, files_to_category = [])
+    def categories_for_file(filename, files_to_category = {})
       files_to_category = Array(files_to_category).compact
       files_to_category = helper.config.files_to_category if files_to_category.empty?
 

data/lib/danger/rules/simple_roulette/Dangerfile

@@ -15,19 +15,33 @@ TABLE_MARKDOWN = <<MARKDOWN
 To spread load more evenly across eligible reviewers, Danger has picked a candidate for each
 review slot. Feel free to
 [override these selections](https://about.gitlab.com/handbook/engineering/projects/##{PROJECT_NAME})
-if you think someone else would be better-suited.
+if you think someone else would be better-suited
+or use the [GitLab Review Workload Dashboard](https://gitlab-org.gitlab.io/gitlab-roulette/) to find other available reviewers.
 
 To read more on how to use the reviewer roulette, please take a look at the
 [Engineering workflow](https://about.gitlab.com/handbook/engineering/workflow/#basics)
 and [code review guidelines](https://docs.gitlab.com/ee/development/code_review.html).
+Please consider assigning a reviewer or maintainer who is a
+[domain expert](https://about.gitlab.com/handbook/engineering/projects/#gitlab-development-kit) in the area of the merge request.
 
 Once you've decided who will review this merge request, mention them as you
 normally would! Danger does not automatically notify them for you.
 
+MARKDOWN
+
+TABLE_HEADER_WITH_CATEGORIES = <<MARKDOWN
+| Category | Reviewer | Maintainer |
+| -------- | -------- | ---------- |
+MARKDOWN
+
+TABLE_HEADER_WITHOUT_CATEGORIES = <<MARKDOWN
 | Reviewer | Maintainer |
 | -------- | ---------- |
 MARKDOWN
 
+OPTIONAL_REVIEW_TEMPLATE = '%{role} review is optional'
+NOT_AVAILABLE_TEMPLATE = 'No %{role} available'
+
 def note_for_spins_role(spins, role)
   spins.each do |spin|
     note = note_for_spin_role(spin, role)
@@ -35,27 +49,48 @@ def note_for_spins_role(spins, role)
     return note if note
   end
 
-  'No %{role} available' % { role: role }
+  NOT_AVAILABLE_TEMPLATE % { role: role }
 end
 
 def note_for_spin_role(spin, role)
+  if spin.optional_role == role
+    return OPTIONAL_REVIEW_TEMPLATE % { role: role.capitalize }
+  end
+
   spin.public_send(role)&.markdown_name(author: roulette.team_mr_author)
 end
 
-def markdown_row_for_spins(spins_array)
+def markdown_row_for_spins(category = nil, spins_array)
   reviewer_note = note_for_spins_role(spins_array, :reviewer)
   maintainer_note = note_for_spins_role(spins_array, :maintainer)
 
-  "#{reviewer_note} | #{maintainer_note} |"
+  row = "| #{reviewer_note} | #{maintainer_note} |"
+  row.prepend("| #{helper.label_for_category(category)} ") if categories_defined?
+
+  row
 end
 
-if helper.changes.any?
-  random_roulette_spins = roulette.spin
+def categories_defined?
+  helper.config.files_to_category.any?
+end
+
+def categories(changes)
+  categories_defined? ? changes.keys : [nil]
+end
+
+def table_header
+  categories_defined? ? TABLE_HEADER_WITH_CATEGORIES : TABLE_HEADER_WITHOUT_CATEGORIES
+end
+
+changes = helper.changes_by_category
+
+if changes.any?
+  random_roulette_spins = roulette.spin(nil, categories(changes))
 
   rows = random_roulette_spins.map do |spin|
-    markdown_row_for_spins([spin])
+    markdown_row_for_spins(spin.category, [spin])
   end
 
   markdown(MESSAGE)
-  markdown(TABLE_MARKDOWN + rows.join("\n")) unless rows.empty?
+  markdown(TABLE_MARKDOWN + table_header + rows.join("\n")) unless rows.empty?
 end

data/lib/gitlab/dangerfiles/config.rb

@@ -25,7 +25,7 @@ module Gitlab
       DEFAULT_COMMIT_MESSAGES_MAX_COMMITS_COUNT = 10
 
       def initialize
-        @files_to_category = []
+        @files_to_category = {}
         @project_name = ENV["CI_PROJECT_NAME"]
         @code_size_thresholds = DEFAULT_CHANGES_SIZE_THRESHOLDS
         @max_commits_count = DEFAULT_COMMIT_MESSAGES_MAX_COMMITS_COUNT

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "2.6.1"
+    VERSION = "2.7.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-01 00:00:00.000000000 Z
+date: 2021-12-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-gitlab