gitlab-dangerfiles 4.7.0 → 4.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3462c1433faf49899f1472e4411ce488ada1b6f59da331ede45114703fe2dfa
-  data.tar.gz: 37b7134a0cec36afed2dc1a4d78321cf9c9a80a405c5551fe52b2ce4834fd312
+  metadata.gz: b42206a72b735d7a0016622666b37571d85d541a758d5454fbca3260e359f1f2
+  data.tar.gz: ac570434fc3dee200d7656a557668454e2ceb5719c43d49b80c364688d3d0e13
 SHA512:
-  metadata.gz: 9a7d44496574a8336bd42665f3c096e4b5c4bb7eeb322533b0b0a84d901d541104878fa13ab214a80fecea15c5c875ad4cb6f98d751b290b8f00108d2d837816
-  data.tar.gz: c032a92c6fb18de185e1552faabc9b648573ff95ee1d0b5e88fe3f57c7668e502d251cb51f2bd9e4b36d555c147cb9f538f6904223546b3e4fbbb5591d9826b5
+  metadata.gz: '030678a153058f6c0ab3fdb198d109ca43b8693f763a6259585b2864c7d688faec108dbbe93285226a7b926ab6f99423b6b57d703f83004b588df27917582d22'
+  data.tar.gz: 7a3398d6bc48bdbd28a43329c311088c211b6343e00200a782b0eef9503dae39befeaaa139710847d3a674e1032508b8c938ef889f7907d9739548919fa12c97

data/.gitlab/CODEOWNERS

@@ -1 +1 @@
-* @gl-quality/eng-prod
+* @gl-dx/eng-prod

data/.gitlab-ci.yml

@@ -50,16 +50,13 @@ include:
     inputs:
       smoke_test_script: "ruby -r 'gitlab-dangerfiles' -e \"puts Gitlab::Dangerfiles::VERSION\""
   - component: gitlab.com/gitlab-org/components/danger-review/danger-review@~latest
+    inputs:
+      dry_run: true
   - template: Security/Dependency-Scanning.gitlab-ci.yml
 
 # run security jobs on MRs
 # see: https://gitlab.com/gitlab-org/gitlab/-/issues/218444#note_478761991
 
-brakeman-sast:
-  rules:
-    - if: '$CI_MERGE_REQUEST_IID'
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-
 gemnasium-dependency_scanning:
   rules:
     - if: '$CI_MERGE_REQUEST_IID'

data/.rubocop.yml

@@ -36,22 +36,6 @@ Style/HashSyntax:
   # Introduced in Ruby 3.1. Disable for now.
   EnforcedShorthandSyntax: never
 
-# To respect rufo formatting
-Style/StringLiterals:
-  EnforcedStyle: double_quotes
-
-# To respect rufo formatting
-Style/TrailingCommaInHashLiteral:
-  EnforcedStyleForMultiline: consistent_comma
-
-# To respect rufo formatting
-Style/TrailingCommaInArguments:
-  Enabled: false
-
-# To respect rufo formatting
-Layout/MultilineOperationIndentation:
-  Enabled: false
-
 # Was problematic, and not included in the .rubocop_todo.yml
 GitlabSecurity/PublicSend:
   Enabled: false

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-dangerfiles (4.7.0)
+    gitlab-dangerfiles (4.8.1)
       danger (>= 9.3.0)
       danger-gitlab (>= 8.0.0)
       rake (~> 13.0)

data/README.md

@@ -69,6 +69,52 @@ end
 
 Note that your custom plugins and rules (unless you exclude them with `except`) are automatically imported by the gem.
 
+### Import and load order
+
+Plugins are imported in alphabetical order. Gem plugins are loaded before
+project-local plugins.
+
+Gem and project-local rules are combined, filtered, and loaded in alphabetical order.
+
+Because all rules are executed as soon as they are imported, you should move all
+logic from your root `Dangerfile` to project-local rules in
+`danger/*/Dangerfile`.
+
+For example:
+
+**Bad**
+
+`Dangerfile`:
+
+```ruby
+Gitlab::Dangerfiles.for_project(self) do |dangerfiles|
+  dangerfiles.import_dangerfiles(only: %w[z_add_labels])
+end
+
+# Bad, because gem rule `z_add_labels` has already been executed with empty labels list.
+helper.labels_to_add << 'important'
+```
+
+**Good**
+
+`Dangerfile`:
+
+```ruby
+Gitlab::Dangerfiles.for_project(self) do |dangerfiles|
+  dangerfiles.import_dangerfiles(only: %w[z_add_labels])
+end
+```
+
+`danger/labels/Dangerfile`:
+
+```ruby
+# Good. Execution order:
+# * root `Dangerfile`
+# * project-local `danger/my_labels/Dangerfile`
+# * gem rule `danger/z_add_labels/Dangerfile`
+helper.labels_to_add << 'important'
+```
+
 ### Plugins
 
 Danger plugins are located under `lib/danger/plugins`.

data/lefthook.yml

@@ -12,8 +12,3 @@ pre-push:
     rubocop:
       run: bundle exec rubocop
       glob: '*.rb'
-
-    # Ruby formatting checks
-    rufo:
-      run: bundle exec rufo --check .
-      glob: '*.rb'

data/lib/danger/plugins/changelog.rb

@@ -23,7 +23,7 @@ module Danger
 
     OPTIONAL_CHANGELOG_MESSAGE = {
       local: "If this merge request [doesn't need a CHANGELOG entry](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry), feel free to ignore this message.",
-      ci: <<~MSG,
+      ci: <<~MSG
         If this merge request needs a changelog entry, add the `Changelog` trailer to the commit message you want to add to the changelog.
 
         If this merge request [doesn't need a CHANGELOG entry](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry), feel free to ignore this message.
@@ -33,11 +33,11 @@ module Danger
 
     REQUIRED_CHANGELOG_REASONS = {
       db_changes: "introduces a database migration",
-      feature_flag_removed: "removes a feature flag",
+      feature_flag_removed: "removes a feature flag"
     }.freeze
     REQUIRED_CHANGELOG_MESSAGE = {
       local: "This merge request requires a changelog entry because it [%<reason>s](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry).",
-      ci: <<~MSG,
+      ci: <<~MSG
         To create a changelog entry, add the `Changelog` trailer to one of your Git commit messages.
 
         This merge request requires a changelog entry because it [%<reason>s](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry).
@@ -123,6 +123,10 @@ module Danger
 
     def revert_in_current_milestone?
       return false unless helper.revert_mr?
+      # In dry-run mode, without the API token, we are able to fetch the current milestone nor the labels.
+      # We simply assume that we are reverting in the current milestone.
+      return true unless helper.ci?
+      return false unless helper.current_milestone
 
       current_regression_label = "regression:#{helper.current_milestone.title}"
 
@@ -249,7 +253,7 @@ module Danger
       required_reasons.each_with_object({}) do |required_reason, memo|
         memo[required_reason] =
           CHANGELOG_MISSING_URL_TEXT +
-            (helper.ci? ? format(REQUIRED_CHANGELOG_MESSAGE[:ci], reason: REQUIRED_CHANGELOG_REASONS.fetch(required_reason)) : REQUIRED_CHANGELOG_MESSAGE[:local])
+          format(REQUIRED_CHANGELOG_MESSAGE[helper.ci? ? :ci : :local], reason: REQUIRED_CHANGELOG_REASONS.fetch(required_reason))
       end
     end
 

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

@@ -30,6 +30,7 @@ module Danger
       Authentication: '~"group::authentication"',
       Authorization: '~"group::authorization"',
       Compliance: '~"group::compliance"',
+      Verify: '~"devops::verify"'
     }.freeze
     # rubocop:enable Style/HashSyntax
 
@@ -345,11 +346,18 @@ module Danger
       )
     end
 
-    # @return [Boolean] +false+ when not in the CI context, and returns +true+ if the MR title starts with Revert or revert
-    def revert_mr?
-      return false unless ci?
+    MR_REVERT_START_WITH = /[Rr]evert /
 
-      mr_title.start_with?(/[Rr]evert/)
+    # When API token is available matches MR title to start with "Revert " or "revert ".
+    # Otherwise, matches if the single commit's message starts with "Revert " or "revert ".
+    #
+    # @return [Boolean] whether an MR is a revert
+    def revert_mr?
+      if ci?
+        mr_title.start_with?(MR_REVERT_START_WITH)
+      else
+        git.commits.size == 1 && git.commits.first.message.start_with?(MR_REVERT_START_WITH)
+      end
     end
 
     # @return [Boolean] +true+ when not in the CI context, and whether the MR is set to be squashed otherwise.
@@ -476,7 +484,10 @@ module Danger
       @labels_to_add ||= []
     end
 
+    # @return [Hash] the current API milestone object or +nil+ if run in dry-run mode
     def current_milestone
+      return unless ci?
+
       @current_milestone ||= gitlab_helper.api.group_milestones(GITLAB_ORG_GROUP_ID, state: "active")
         .auto_paginate
         .select { |m| m.title.match?(/\A\d+\.\d+\z/) && !m.expired && m.start_date && m.due_date }

data/lib/danger/plugins/roulette.rb

@@ -136,10 +136,10 @@ module Danger
 
     def prepare_ux_category!(categories)
       if labels.include?("Community contribution") ||
-        # We only want to spin a reviewer for merge requests which has a
-        # designer for the team.
-        Gitlab::Dangerfiles::Teammate.has_member_for_the_group?(
-          :ux, project: config_project_name.downcase, labels: labels)
+          # We only want to spin a reviewer for merge requests which has a
+          # designer for the team.
+          Gitlab::Dangerfiles::Teammate.has_member_for_the_group?(
+            :ux, project: config_project_name.downcase, labels: labels)
         categories << :ux
       end
     end

data/lib/danger/rules/commit_messages/Dangerfile

@@ -96,11 +96,6 @@ def lint_commits(commits)
     if multi_line_commit_linter && multi_line_commit_linter.failed?
       warn_or_fail_commits(multi_line_commit_linter)
       commit_linters.delete(multi_line_commit_linter) # Don't show an error (here) and a warning (below)
-    elsif helper.ci? # We don't have access to the MR title locally
-      title_linter = lint_mr_title(helper.mr_title)
-      if title_linter.failed?
-        warn_or_fail_commits(title_linter)
-      end
     end
   else
     if count_non_fixup_commits(commit_linters) > MAX_COMMITS_COUNT

data/lib/danger/rules/simple_roulette/Dangerfile

@@ -16,13 +16,15 @@ To spread load more evenly across eligible reviewers, Danger has picked a candid
 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
-or use the [GitLab Review Workload Dashboard](https://gitlab-org.gitlab.io/gitlab-roulette/) to find other available reviewers.
+or use the [GitLab Review Workload Dashboard](https://gitlab-org.gitlab.io/gitlab-roulette/?currentProject=#{PROJECT_NAME})
+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.
+[domain expert](https://about.gitlab.com/handbook/engineering/projects/##{PROJECT_NAME})
+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.

data/lib/gitlab/dangerfiles/base_linter.rb

@@ -16,7 +16,7 @@ module Gitlab
           subject_too_long: "The %s may not be longer than #{MAX_LINE_LENGTH} characters",
           subject_starts_with_a_space: "The %s must not start with a space",
           subject_starts_with_lowercase: "The %s must start with a capital letter",
-          subject_ends_with_a_period: "The %s must not end with a period",
+          subject_ends_with_a_period: "The %s must not end with a period"
         }
       end
 

data/lib/gitlab/dangerfiles/capability.rb

@@ -17,7 +17,7 @@ module Gitlab
           tooling: Tooling,
           import_integrate_be: ImportIntegrateBE,
           import_integrate_fe: ImportIntegrateFE,
-          ux: UX,
+          ux: UX
         }.freeze
       end
       private_class_method :category_to_class

data/lib/gitlab/dangerfiles/commit_linter.rb

@@ -26,7 +26,7 @@ module Gitlab
             message_contains_unicode_emoji: "Avoid the use of Unicode Emoji. These add no value to the commit " \
             "message, and may not be displayed properly everywhere",
             message_contains_short_reference: "Use full URLs instead of short references (`gitlab-org/gitlab#123` or " \
-            "`!123`), as short references are displayed as plain text outside of GitLab",
+            "`!123`), as short references are displayed as plain text outside of GitLab"
           }
         )
       end
@@ -148,7 +148,7 @@ module Gitlab
 
       def message_contains_short_reference?
         match_data = commit.message.match(SHORT_REFERENCE_REGEX) ||
-                     commit.message.match(MS_SHORT_REFERENCE_REGEX)
+          commit.message.match(MS_SHORT_REFERENCE_REGEX)
 
         return false unless match_data
 

data/lib/gitlab/dangerfiles/emoji_checker.rb

@@ -27,7 +27,7 @@ module Gitlab
 
       def initialize
         names = JSON.parse(File.read(DIGESTS)).keys +
-                JSON.parse(File.read(ALIASES)).keys
+          JSON.parse(File.read(ALIASES)).keys
 
         @emoji = names.map { |name| ":#{name}:" }
       end

data/lib/gitlab/dangerfiles/spec_helper.rb

@@ -17,7 +17,7 @@ module DangerSpecHelper
       "GITLAB_CI" => "true",
       "DANGER_GITLAB_HOST" => "gitlab.example.com",
       "CI_MERGE_REQUEST_IID" => 28_493,
-      "DANGER_GITLAB_API_TOKEN" => "123sbdq54erfsd3422gdfio",
+      "DANGER_GITLAB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
     }
   end
 
@@ -93,7 +93,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Backend engineer",
       "projects" => backend_maintainer_project,
       "available" => backend_available,
-      "tz_offset_hours" => backend_tz_offset_hours,
+      "tz_offset_hours" => backend_tz_offset_hours
     )
   end
 
@@ -104,7 +104,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Backend engineer",
       "projects" => backend_maintainer_project,
       "available" => backend_available,
-      "tz_offset_hours" => backend_tz_offset_hours,
+      "tz_offset_hours" => backend_tz_offset_hours
     )
   end
 
@@ -116,7 +116,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Backend engineer",
       "projects" => { "gitlab" => "reviewer backend" },
       "available" => backend_reviewer_available,
-      "tz_offset_hours" => 1.0,
+      "tz_offset_hours" => 1.0
     )
   end
 
@@ -127,7 +127,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Frontend engineer",
       "projects" => { "gitlab" => "reviewer frontend" },
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -138,7 +138,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Frontend engineer",
       "projects" => { "gitlab" => "maintainer frontend" },
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -150,7 +150,7 @@ RSpec.shared_context "with teammates" do
       "projects" => { "gitlab" => "reviewer ux" },
       "specialty" => "Create: Source Code",
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -161,7 +161,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Software Engineer in Test, Create:Source Code",
       "projects" => { "gitlab" => "maintainer qa", "gitlab-qa" => "maintainer" },
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -172,7 +172,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Frontend Engineer, Manage:Import and Integrate",
       "projects" => { "gitlab" => "reviewer frontend" },
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -183,7 +183,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Backend Engineer, Manage:Import and Integrate",
       "projects" => { "gitlab" => "reviewer backend" },
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -194,7 +194,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Engineering Productivity",
       "projects" => { "gitlab" => "reviewer tooling" },
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -205,7 +205,7 @@ RSpec.shared_context "with teammates" do
       "role" => '~"ci::templates"',
       "projects" => { "gitlab" => "reviewer ci_template" },
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -216,7 +216,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Backend Engineer, Analytics: Analytics Instrumentation",
       "projects" => { "gitlab" => "reviewer analytics_instrumentation" },
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -227,7 +227,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Backend Engineer, Manage:Import and Integrate",
       "projects" => { "gitlab" => "reviewer backend" },
       "available" => backend_reviewer_available,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -238,7 +238,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Frontend Engineer, Manage:Import and Integrate",
       "projects" => { "gitlab" => "reviewer frontend" },
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -249,7 +249,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Backend engineer",
       "projects" => { "gitlab-workhorse" => "reviewer" },
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 
@@ -260,7 +260,7 @@ RSpec.shared_context "with teammates" do
       "role" => "Backend engineer",
       "projects" => { "gitlab-workhorse" => "maintainer" },
       "available" => true,
-      "tz_offset_hours" => 2.0,
+      "tz_offset_hours" => 2.0
     )
   end
 

data/lib/gitlab/dangerfiles/spinner.rb

@@ -71,8 +71,8 @@ module Gitlab
             # contribution even without a team designer. We assign this to Pedro.
             spin.reviewer = ux_fallback_wider_community_reviewer if
               labels.include?("Community contribution") &&
-              spin.no_reviewer? &&
-              spin.no_maintainer?
+                spin.no_reviewer? &&
+                spin.no_maintainer?
           end
         end
 

data/lib/gitlab/dangerfiles/teammate.rb

@@ -86,7 +86,7 @@ module Gitlab
         @username = options["username"]
         @name = options["name"]
         @markdown_name = options["markdown_name"] ||
-                         default_markdown_name(options["username"])
+          default_markdown_name(options["username"])
         @role = options["role"]
         @specialty = options["specialty"]
         @projects = process_projects(options["projects"])

data/lib/gitlab/dangerfiles/type_label_guesser.rb

@@ -9,7 +9,7 @@ module Gitlab
         performance: %w[type::bug bug::performance],
         added: %w[type::feature feature::addition],
         deprecated: %w[type::maintenance maintenance::removal],
-        removed: %w[type::maintenance maintenance::removal],
+        removed: %w[type::maintenance maintenance::removal]
       }.freeze
 
       def labels_from_changelog_categories(categories)

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "4.7.0"
+    VERSION = "4.8.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 4.7.0
+  version: 4.8.1
 platform: ruby
 authors:
 - GitLab
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-11 00:00:00.000000000 Z
+date: 2025-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -282,7 +282,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.3.27
 signing_key:
 specification_version: 4
 summary: This gem provides common Dangerfile and plugins for GitLab projects.