gitlab-dangerfiles 3.6.3 → 3.6.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 719c4b19692de44772e95901fe7cd45c0bc75c19474babd21a554cf95bb58238
-  data.tar.gz: 768847102d15a2680125ffde73a373bf42bf30ff2d7911b0fdd78e94e7661741
+  metadata.gz: 1a126428046a10355043b190fbf80e70dec6c01a6e9d8778770455a8c30d748c
+  data.tar.gz: 65060b4bd492f3887c22fb6a09fba51c5262f4680e45c364a1ec775a1968a844
 SHA512:
-  metadata.gz: 48812fba8c3a3507980a276f5322dad66ff499f7630d9a0e46c242e656f0e4e4838eb245a9d8c6386d74c0a1caff02cedbd4a37ceb38ccef75894eef98249cef
-  data.tar.gz: 5220bf93967c1a88b375107b8ec6ce28a87ea0109ecce8e10c56dcd540209ab402c9e74c745cfaf7431edc9a01cc4c36fb0e7dc53ae9874101bbf2980293ea88
+  metadata.gz: 4ca9f2ea3ebf80b9fa8f0f7ce19a01309acc2e120c8661fd618f59b0e48bf638098826257050be4af32cc9553c797dd3af1cd7a1784d234f27c240ec407a6ada
+  data.tar.gz: 14ba2e996756f8beab4e046e87a1d6739285cdf55dbdcf357bdc6768f8a1ff7101797e6c5baf7fce90aa28dfbe3f41c28f3b386a4351090003162368271432cc

data/.rubocop.yml

@@ -32,9 +32,14 @@ Style/HashSyntax:
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
+# To respect rufo formatting
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: consistent_comma
 
+# To respect rufo formatting
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
 # Was problematic, and not included in the .rubocop_todo.yml
 GitlabSecurity/PublicSend:
   Enabled: false

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2022-09-23 13:42:34 UTC using RuboCop version 1.36.0.
+# on 2023-01-12 11:28:46 UTC using RuboCop version 1.36.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -86,18 +86,6 @@ Layout/LineEndStringConcatenationIndentation:
   Exclude:
     - 'lib/gitlab/dangerfiles/commit_linter.rb'
 
-# Offense count: 7
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, IndentationWidth.
-# SupportedStyles: aligned, indented
-Layout/MultilineOperationIndentation:
-  Exclude:
-    - 'lib/danger/plugins/changelog.rb'
-    - 'lib/gitlab/dangerfiles/commit_linter.rb'
-    - 'lib/gitlab/dangerfiles/emoji_checker.rb'
-    - 'lib/gitlab/dangerfiles/teammate.rb'
-    - 'spec/danger/plugins/roulette_spec.rb'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 Layout/RescueEnsureAlignment:
@@ -157,21 +145,6 @@ Lint/RedundantDirGlobSort:
     - 'spec/gitlab/dangerfiles_spec.rb'
     - 'spec/spec_helper.rb'
 
-# Offense count: 1
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods, CountRepeatedAttributes.
-Metrics/AbcSize:
-  Max: 67
-
-# Offense count: 1
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
-Metrics/CyclomaticComplexity:
-  Max: 31
-
-# Offense count: 1
-# Configuration parameters: AllowedMethods, AllowedPatterns, IgnoredMethods.
-Metrics/PerceivedComplexity:
-  Max: 26
-
 # Offense count: 1
 # Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
 # CheckDefinitionPathHierarchyRoots: lib, spec, test, src
@@ -238,7 +211,7 @@ RSpec/EmptyLineAfterLetBlock:
   Exclude:
     - 'spec/danger/plugins/internal/helper_spec.rb'
 
-# Offense count: 3
+# Offense count: 7
 RSpec/ExpectInHook:
   Exclude:
     - 'spec/danger/plugins/internal/helper_spec.rb'
@@ -267,7 +240,7 @@ RSpec/LetBeforeExamples:
     - 'spec/danger/plugins/internal/helper_spec.rb'
     - 'spec/danger/plugins/roulette_spec.rb'
 
-# Offense count: 47
+# Offense count: 51
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: Strict, EnforcedStyle, AllowedExplicitMatchers.
 # SupportedStyles: inflected, explicit
@@ -282,7 +255,7 @@ RSpec/RepeatedExampleGroupDescription:
   Exclude:
     - 'spec/gitlab/dangerfiles/commit_linter_spec.rb'
 
-# Offense count: 31
+# Offense count: 33
 # Configuration parameters: IgnoreNameless, IgnoreSymbolicNames.
 RSpec/VerifiedDoubles:
   Exclude:
@@ -362,7 +335,7 @@ Style/IfInsideElse:
   Exclude:
     - 'lib/danger/rules/commit_messages/Dangerfile'
 
-# Offense count: 23
+# Offense count: 22
 # This cop supports safe autocorrection (--autocorrect).
 Style/IfUnlessModifier:
   Exclude:
@@ -403,11 +376,6 @@ Style/NumericPredicate:
     - 'lib/danger/plugins/roulette.rb'
     - 'lib/gitlab/dangerfiles/teammate.rb'
 
-# Offense count: 1
-Style/OptionalArguments:
-  Exclude:
-    - 'lib/danger/rules/simple_roulette/Dangerfile'
-
 # Offense count: 8
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: PreferredDelimiters.
@@ -420,7 +388,7 @@ Style/PercentLiteralDelimiters:
     - 'lib/gitlab/dangerfiles/tasks/main.rake'
     - 'spec/danger/plugins/internal/helper_spec.rb'
 
-# Offense count: 2
+# Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: .
 # SupportedStyles: same_as_string_literals, single_quotes, double_quotes
@@ -444,12 +412,6 @@ Style/RedundantFreeze:
     - 'lib/gitlab/dangerfiles/emoji_checker.rb'
     - 'lib/gitlab/dangerfiles/title_linting.rb'
 
-# Offense count: 1
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/RedundantInterpolation:
-  Exclude:
-    - 'lib/gitlab/dangerfiles/teammate.rb'
-
 # Offense count: 4
 # This cop supports safe autocorrection (--autocorrect).
 Style/RedundantRegexpEscape:
@@ -521,7 +483,7 @@ Style/StringConcatenation:
     - 'spec/gitlab/dangerfiles/commit_linter_spec.rb'
     - 'spec/gitlab/merge_request_linter_spec.rb'
 
-# Offense count: 6
+# Offense count: 7
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle.
 # SupportedStyles: single_quotes, double_quotes
@@ -549,7 +511,7 @@ Style/TrailingCommaInArguments:
   Exclude:
     - 'spec/danger/plugins/roulette_spec.rb'
 
-# Offense count: 18
+# Offense count: 24
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyleForMultiline.
 # SupportedStylesForMultiline: comma, consistent_comma, no_comma
@@ -565,22 +527,3 @@ Style/TrailingCommaInArrayLiteral:
     - 'spec/gitlab/dangerfiles/title_linting_spec.rb'
     - 'spec/gitlab/dangerfiles/weightage/maintainers_spec.rb'
     - 'spec/gitlab/dangerfiles/weightage/reviewers_spec.rb'
-
-# Offense count: 29
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInHashLiteral:
-  Exclude:
-    - 'lib/danger/plugins/changelog.rb'
-    - 'lib/danger/plugins/internal/helper.rb'
-    - 'lib/danger/plugins/roulette.rb'
-    - 'lib/gitlab/dangerfiles/base_linter.rb'
-    - 'lib/gitlab/dangerfiles/commit_linter.rb'
-    - 'lib/gitlab/dangerfiles/spec_helper.rb'
-    - 'lib/gitlab/dangerfiles/type_label_guesser.rb'
-    - 'spec/danger/plugins/internal/helper_spec.rb'
-    - 'spec/danger/plugins/roulette_spec.rb'
-    - 'spec/gitlab/dangerfiles/config_spec.rb'
-    - 'spec/gitlab/dangerfiles/teammate_spec.rb'
-    - 'spec/gitlab/dangerfiles_spec.rb'

data/README.md

@@ -128,8 +128,12 @@ project. To use it in your project, perform the following steps:
    see how to set it up.
 1. When using the default roulette, use `import_defaults` or import it manually when setting
    up the gitlab-dangerfiles instance:
+
    ```ruby
+   require 'gitlab-dangerfiles'
+
    Gitlab::Dangerfiles.for_project(self) do |dangerfiles|
+     dangerfiles.import_plugins
      dangerfiles.import_dangerfiles(only: %w[simple_roulette])
    end
    ```

data/lib/danger/plugins/changelog.rb

@@ -15,6 +15,11 @@ module Danger
     CHANGELOG_EE_TRAILER_REGEX = /^EE: true$/.freeze
     CHANGELOG_MODIFIED_URL_TEXT = "**CHANGELOG.md was edited.** Please remove the additions and follow the [changelog guidelines](https://docs.gitlab.com/ee/development/changelog.html).\n\n"
     CHANGELOG_MISSING_URL_TEXT = "**[CHANGELOG missing](https://docs.gitlab.com/ee/development/changelog.html)**:\n\n"
+    IF_REVERT_MR_TEXT = <<~MARKDOWN
+      If you are in a revert MR, consider using the revert MR template to add labels to skip changelog checks ([docs](https://docs.gitlab.com/ee/development/pipelines#revert-mrs)).
+
+      If this is reverting something in the current milestone, we don't need to add a changelog. In this case, we can skip changelog checks by adding `~"regression:*"` label, and re-run the danger job (there is a link at the bottom of this comment).
+    MARKDOWN
 
     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.",
@@ -110,25 +115,47 @@ module Danger
       valid_changelog_commits.map(&:category)
     end
 
-    # rubocop:disable Style/SignalException
     def check!
-      if git.modified_files.include?("CHANGELOG.md")
-        fail modified_text
-      end
+      return if revert_in_current_milestone?
+
+      critical_checks
+      regular_checks
+      changelog_categories_checks
+    end
+
+    def revert_in_current_milestone?
+      return false unless helper.revert_mr?
+
+      current_regression_label = "regression:#{helper.current_milestone.title}"
+
+      helper.mr_labels.any?(current_regression_label)
+    end
 
+    def critical_checks
+      check_result = ChangelogCheckResult.empty
+
+      check_result.error(modified_text) if git.modified_files.include?("CHANGELOG.md")
+
+      # Help the user to apply the correct labels to skip this danger check in case it's a revert MR
+      check_result.warning(IF_REVERT_MR_TEXT)
+
+      add_danger_messages(check_result)
+    end
+
+    def regular_checks
       if exist?
         add_danger_messages(check_changelog_path)
       elsif required?
-        required_texts.each { |_, text| fail(text) } # rubocop:disable Lint/UnreachableLoop
+        required_texts.each { |_, text| fail(text) } # rubocop:disable Lint/UnreachableLoop, Style/SignalException
       elsif optional?
         message optional_text
       end
+    end
 
+    def changelog_categories_checks
       check_changelog_commit_categories
     end
 
-    # rubocop:enable Style/SignalException
-
     # rubocop:disable Style/SignalException
     def add_danger_messages(check_result)
       check_result.errors.each { |error| fail(error) } # rubocop:disable Lint/UnreachableLoop

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

@@ -12,9 +12,11 @@ module Danger
   # Common helper functions for our danger scripts.
   class Helper < Danger::Plugin
     RELEASE_TOOLS_BOT = "gitlab-release-tools-bot"
+    # rubocop:disable Style/HashSyntax
     CATEGORY_LABELS = {
       docs: "~documentation", # Docs are reviewed along DevOps stages, so don't need roulette for now.
-      none: "",
+      none: "None",
+      nil => "N/A",
       qa: "~QA",
       ux: "~UX",
       codeowners: '~"Code Owners"',
@@ -29,6 +31,9 @@ module Danger
       "Authentication and Authorization": '~"group::authentication and authorization"',
       Compliance: '~"group::compliance"',
     }.freeze
+    # rubocop:enable Style/HashSyntax
+
+    GITLAB_ORG_GROUP_ID = "9970"
 
     # Allows to set specific rule's configuration by passing a block.
     #
@@ -228,7 +233,7 @@ module Danger
         found
       end
 
-      Array(categories || :unknown)
+      Array(categories || :none)
     end
 
     # @param category [Symbol] A category.
@@ -317,6 +322,13 @@ 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_title.start_with?(/[Rr]evert/)
+    end
+
     # @return [Boolean] +true+ when not in the CI context, and whether the MR is set to be squashed otherwise.
     def squash_mr?
       return true unless ci?
@@ -432,6 +444,12 @@ module Danger
       @labels_to_add ||= []
     end
 
+    def current_milestone
+      @current_milestone ||= gitlab_helper.api.group_milestones(GITLAB_ORG_GROUP_ID, state: "active")
+        .select { |m| m.title.match?(/\A\d+\.\d+\z/) && !m.expired && m.start_date && m.due_date }
+        .min_by(&:start_date)
+    end
+
     private
 
     # @return [Danger::RequestSources::GitLab, nil] the +gitlab+ helper, or +nil+ when it's not available.

data/lib/danger/plugins/roulette.rb

@@ -48,9 +48,10 @@ module Danger
     # @param timezone_experiment [Boolean] Whether to select reviewers based in timezone or not.
     #
     # @return [Array<Spin>]
-    def spin(project = nil, categories = [nil], timezone_experiment: false)
+    # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+    def spin(project = nil, categories = [:none], timezone_experiment: false)
       project = (project || config_project_name).downcase
-      categories = categories.map { |category| category&.downcase }
+      categories = categories.map { |category| category&.downcase || :none }
       categories.reject! { |category| integrations_reject_category?(category, project) }
 
       spins = categories.sort_by(&:to_s).map do |category|
@@ -67,7 +68,8 @@ module Danger
         case spin.category
         when :qa
           # MR includes QA changes, but also other changes, and author isn't an SET
-          if categories.size > 1 && !team_mr_author&.any_capability?(project, spin.category)
+          if categories.size > 1 &&
+             !(team_mr_author && team_mr_author.capabilities(project).any? { |capability| capability.end_with?("qa") })
             spin.optional_role = :maintainer
           end
         when :test
@@ -104,6 +106,8 @@ module Danger
       spins
     end
 
+    # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
     def required_approvals
       approval_rules = helper.mr_approval_state["rules"]
 

data/lib/danger/rules/simple_roulette/Dangerfile

@@ -60,12 +60,12 @@ def note_for_spin_role(spin, role)
   spin.public_send(role)&.markdown_name(author: roulette.team_mr_author)
 end
 
-def markdown_row_for_spins(category = nil, spins_array, has_categories:)
+def markdown_row_for_spins(category, spins_array, show_category_column:)
   reviewer_note = note_for_spins_role(spins_array, :reviewer)
   maintainer_note = note_for_spins_role(spins_array, :maintainer)
 
   row = +"| #{reviewer_note} | #{maintainer_note} |"
-  row.prepend("| #{helper.label_for_category(category)} ") if has_categories
+  row.prepend("| #{helper.label_for_category(category)} ") if show_category_column
   row
 end
 
@@ -73,7 +73,7 @@ changes = helper.changes_by_category
 
 # Replicating label based categories from:
 # https://gitlab.com/gitlab-org/gitlab/-/blob/master/danger/roulette/Dangerfile
-categories = Set.new(changes.keys - [:unknown])
+categories = Set.new(changes.keys)
 
 # Ensure to spin for database reviewer/maintainer when ~database is applied (e.g. to review SQL queries)
 categories << :database if helper.mr_labels.include?('database')
@@ -91,15 +91,14 @@ categories.delete(:product_intelligence) if helper.mr_labels.include?("growth ex
 categories.subtract(helper.config.disabled_roulette_categories)
 
 if changes.any?
-  has_categories = categories.any?
-  categories = [nil] unless has_categories
+  show_category_column = categories.size > 1 || categories.first != :none
   random_roulette_spins = roulette.spin(nil, categories)
 
   rows = random_roulette_spins.map do |spin|
-    markdown_row_for_spins(spin.category, [spin], has_categories: has_categories)
+    markdown_row_for_spins(spin.category, [spin], show_category_column: show_category_column)
   end
 
-  table_header = has_categories ? TABLE_HEADER_WITH_CATEGORIES : TABLE_HEADER_WITHOUT_CATEGORIES
+  table_header = show_category_column ? TABLE_HEADER_WITH_CATEGORIES : TABLE_HEADER_WITHOUT_CATEGORIES
 
   markdown(MESSAGE)
   markdown(TABLE_MARKDOWN + table_header + rows.join("\n")) unless rows.empty?

data/lib/gitlab/dangerfiles/category.rb

@@ -11,6 +11,7 @@ module Gitlab
 
       def self.name_to_class
         @name_to_class ||= {
+          none: None,
           test: Test,
           tooling: Tooling,
           integrations_be: IntegrationsBE,
@@ -35,8 +36,13 @@ module Gitlab
       end
 
       def capability
-        # name can be nil
-        @capability ||= "#{kind} #{name}".strip
+        @capability ||= "#{kind} #{name}"
+      end
+
+      class None < Category
+        def capability
+          @capability ||= kind.to_s
+        end
       end
 
       class Test < Category

data/lib/gitlab/dangerfiles/teammate.rb

@@ -5,7 +5,8 @@ require_relative "category"
 module Gitlab
   module Dangerfiles
     class Teammate
-      attr_reader :options, :username, :name, :role, :projects, :available, :hungry, :reduced_capacity, :tz_offset_hours
+      attr_reader :options, :username, :name, :role, :projects, :available, :hungry, :reduced_capacity, :tz_offset_hours,
+                  :only_maintainer_reviews
 
       # The options data are produced by https://gitlab.com/gitlab-org/gitlab-roulette/-/blob/master/lib/team_member.rb
       def initialize(options = {})
@@ -20,6 +21,7 @@ module Gitlab
         @hungry = options["hungry"]
         @reduced_capacity = options["reduced_capacity"]
         @tz_offset_hours = options["tz_offset_hours"]
+        @only_maintainer_reviews = options["only_maintainer_reviews"]
       end
 
       def to_h
@@ -40,10 +42,6 @@ module Gitlab
         projects&.has_key?(name)
       end
 
-      def any_capability?(project, category)
-        capabilities(project).any? { |capability| capability.end_with?(category.to_s) }
-      end
-
       def reviewer?(project, category, labels)
         has_capability?(project, category, :reviewer, labels)
       end

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "3.6.3"
+    VERSION = "3.6.5"
   end
 end

data/lib/gitlab/dangerfiles/weightage/reviewers.rb

@@ -33,6 +33,7 @@ module Gitlab
           # https://gitlab.com/gitlab-org/gitlab/issues/26723
 
           remove_traintainers_from_reviewers!
+          remove_maintainer_only_from_reviewers!
 
           weighted_reviewers + weighted_traintainers
         end
@@ -49,6 +50,11 @@ module Gitlab
           reviewers.reject! { |reviewer| traintainers.include?(reviewer) }
         end
 
+        def remove_maintainer_only_from_reviewers!
+          # Using a maintainer-only reviewer emoji, team members can ensure they only get maintainer reviews
+          reviewers.reject! { |reviewer| reviewer&.only_maintainer_reviews }
+        end
+
         def weighted_reviewers
           reviewers.each_with_object([]) do |reviewer, total_reviewers|
             add_weighted_reviewer(total_reviewers, reviewer, DEFAULT_REVIEWER_WEIGHT)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 3.6.3
+  version: 3.6.5
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-11-22 00:00:00.000000000 Z
+date: 2023-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake