gitlab-dangerfiles 2.6.0 → 2.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af398dd6651e65bb4716c5a2c1aee8ee93a9a98c68f4b71f5da3de3d83a2aff2
-  data.tar.gz: cb57a546b8f9c15b1c17ebe9fa6936e312c6f0345e74c6778220ceb56b884c6a
+  metadata.gz: e0819c79b914e2025eecc3b05a52227a9012ceafeac3300032e1abb129706440
+  data.tar.gz: 117a9710932852cf1845d8a8c3a27f331bbe65da0cccdf13f044858d915ea0c1
 SHA512:
-  metadata.gz: 3b4df78cdb34004d811fbd711c251151820382a3ed4de31b26f46e90a8a9f121a2111b2d90de1aeaf390129fccb563bfa679ddc50ef84975a9f6da9ad3aeff6d
-  data.tar.gz: b88f6fb0e0e46d5f089651312fe45a7713ab6f732216d744bf8f24515d6471d08696cd1b2ee1b2290c881972b6ef8c5376a68a74d58fd0ec76e7620009074a16
+  metadata.gz: c93c2983a4a0ebba6f3c94d0b81a1da7ba9fad9eb98573a5862e3d6501ff76614501907bb5d492942a47472160d2db5d1a96fcebdad280379cd3e03a43c5f113
+  data.tar.gz: 734bbb0e6894d8de57f4d48546aca9f085447556662dbc64ba99f7cb39ea166b5a75f3d1099077e09d17f44d3687a9fe733451fa06310e02d906209b6003bcae

data/.gitlab/merge_request_templates/Release.md

@@ -1,13 +1,13 @@
-<!-- Replace `<NEW_VERSION>` with the previous release here, and `<COMMIT_UPDATING_VERSION>`
-with the latest commit from this merge request. -->
-- Diff: https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/compare/v<NEW_VERSION>...<COMMIT_UPDATING_VERSION>
+<!-- Replace `<PREVIOUS_VERSION>` with the previous version number here, `<COMMIT_UPDATING_VERSION>` with the latest
+commit from this merge request, and `<NEW_VERSION>` with the upcoming version number. -->
+## Diff
 
-- Checklist before merging:
-  - [ ] Diff link is up-to-date.
-  - [ ] Based on the diff, `version.rb` is updated, according to [SemVer](https://semver.org).
+https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/compare/v<PREVIOUS_VERSION>...<COMMIT_UPDATING_VERSION>
 
-- 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.
+## Checklist
+
+- [ ] Diff link is up-to-date.
+- [ ] Check the release notes: https://gitlab.com/api/v4/projects/gitlab-org%2Fruby%2Fgems%2Fgitlab-dangerfiles/repository/changelog?version=<NEW_VERSION>
+- [ ] Based on the diff and the release notes, `version.rb` is updated, according to [SemVer](https://semver.org).
 
 /label ~"type::maintenance" ~"static code analysis"

data/.gitlab-ci.yml

@@ -28,12 +28,6 @@ workflow:
       - Gemfile.lock
     policy: pull
 
-danger-review:
-  extends: .default
-  stage: test
-  script:
-    - bundle exec danger --fail-on-errors=true --verbose
-
 test:rspec:
   extends: .default
   stage: test
@@ -52,7 +46,9 @@ include:
   - template: Security/SAST.gitlab-ci.yml
   - template: Security/Secret-Detection.gitlab-ci.yml
   - project: 'gitlab-org/quality/pipeline-common'
-    file: '/ci/gem-release.yml'
+    file:
+      - '/ci/danger-review.yml'
+      - '/ci/gem-release.yml'
 
 # run security jobs on MRs
 # see: https://gitlab.com/gitlab-org/gitlab/-/issues/218444#note_478761991

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/gitlab-dangerfiles.gemspec

@@ -8,15 +8,15 @@ Gem::Specification.new do |spec|
 
   spec.summary = %q{This gem provides common Dangerfile and plugins for GitLab projects.}
   spec.description = %q{This gem provides common Dangerfile and plugins for GitLab projects.}
-  spec.homepage = "https://gitlab.com/gitlab-org/gitlab-dangerfiles"
+  spec.homepage = "https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles"
   spec.license = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
   spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = "https://gitlab.com/gitlab-org/gitlab-dangerfiles"
-  spec.metadata["changelog_uri"] = "https://gitlab.com/gitlab-org/gitlab-dangerfiles/-/releases"
+  spec.metadata["source_code_uri"] = "https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles"
+  spec.metadata["changelog_uri"] = "https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/releases"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.

data/lib/danger/plugins/{helper.rb → internal/helper.rb}

@@ -3,10 +3,10 @@
 require "net/http"
 require "json"
 
-require_relative "../../gitlab/dangerfiles/changes"
-require_relative "../../gitlab/dangerfiles/config"
-require_relative "../../gitlab/dangerfiles/teammate"
-require_relative "../../gitlab/dangerfiles/title_linting"
+require_relative "../../../gitlab/dangerfiles/changes"
+require_relative "../../../gitlab/dangerfiles/config"
+require_relative "../../../gitlab/dangerfiles/teammate"
+require_relative "../../../gitlab/dangerfiles/title_linting"
 
 module Danger
   # Common helper functions for our danger scripts.
@@ -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/plugins/roulette.rb

@@ -22,7 +22,7 @@ module Danger
     #
     # @return [Gitlab::Dangerfiles::Teammate]
     def team_mr_author
-      company_members.find { |person| person.username == helper.mr_author }
+      @team_mr_author ||= company_members.find { |person| person.username == helper.mr_author }
     end
 
     # Assigns GitLab team members to be reviewer and maintainer
@@ -36,6 +36,7 @@ module Danger
     def spin(project = nil, categories = [nil], timezone_experiment: false)
       project = (project || helper.config.project_name).downcase
       categories = categories.map { |category| category&.downcase }
+      categories.reject! { |category| integrations_reject_category?(category, project) }
 
       spins = categories.sort_by(&:to_s).map do |category|
         including_timezone = INCLUDE_TIMEZONE_FOR_CATEGORY.fetch(category, timezone_experiment)
@@ -106,6 +107,14 @@ module Danger
       person.username == helper.mr_author
     end
 
+    # @param [String] category name
+    # @return [Boolean]
+    def integrations_reject_category?(category, project)
+      # Reject integrations categories if the MR author has reviewing abilities for the category.
+      team_mr_author&.integrations_be?(project, category, helper.mr_labels) ||
+        team_mr_author&.integrations_fe?(project, category, helper.mr_labels)
+    end
+
     def new_random(seed)
       Random.new(Digest::MD5.hexdigest(seed).to_i(16))
     end

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.0"
+    VERSION = "2.8.0"
   end
 end

data/lib/gitlab/dangerfiles.rb

@@ -42,6 +42,9 @@ module Gitlab
       # @return [Gitlab::Dangerfiles::Engine]
       def initialize(dangerfile)
         @dangerfile = dangerfile
+
+        # Import internal plugins eagerly, since other functionality in this class may depend on them.
+        danger_plugin.import_plugin(File.expand_path("../danger/plugins/internal/*.rb", __dir__))
       end
 
       # Import all available plugins.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.8.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-gitlab
@@ -149,7 +149,7 @@ files:
 - fixtures/emojis/aliases.json
 - fixtures/emojis/digests.json
 - gitlab-dangerfiles.gemspec
-- lib/danger/plugins/helper.rb
+- lib/danger/plugins/internal/helper.rb
 - lib/danger/plugins/roulette.rb
 - lib/danger/rules/changes_size/Dangerfile
 - lib/danger/rules/commit_messages/Dangerfile
@@ -170,14 +170,14 @@ files:
 - lib/gitlab/dangerfiles/weightage.rb
 - lib/gitlab/dangerfiles/weightage/maintainers.rb
 - lib/gitlab/dangerfiles/weightage/reviewers.rb
-homepage: https://gitlab.com/gitlab-org/gitlab-dangerfiles
+homepage: https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles
 licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-  homepage_uri: https://gitlab.com/gitlab-org/gitlab-dangerfiles
-  source_code_uri: https://gitlab.com/gitlab-org/gitlab-dangerfiles
-  changelog_uri: https://gitlab.com/gitlab-org/gitlab-dangerfiles/-/releases
+  homepage_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles
+  source_code_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles
+  changelog_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/releases
 post_install_message: 
 rdoc_options: []
 require_paths: