gitlab-dangerfiles 3.7.0 → 3.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c8b3755415a3a732fc13c70da4176927062a9d5b6452a7d2513d3ef29617c89
-  data.tar.gz: 1822e18dcc9e51d93f0ea1f3df574aaf5c1dd5ec1b0fd552bfea34f8b114971d
+  metadata.gz: 5759d8762183090115e7cb10b4b2d7244735d3225b53966c8feaf28e9d9eee7e
+  data.tar.gz: f49d06c663430072bad4c4f05b8bd1f509ca2c1a095bd1e499e3870fbe061fc9
 SHA512:
-  metadata.gz: d86af6131e0703fcab736fb75f09b62d1e656bec379f76f8bee6223899e99b34a085c86dc94d7c6d99ce88642acbea4d9079050ab50331abbc10d6c47c0fcc76
-  data.tar.gz: dc878dcd339bed44e0cb4059ec965cce1f6e0513099002126779640c3f8986417bbfabdbbec1ffd4137729839d682d8f7bc6f69cf1654ee03b9a75007f561f93
+  metadata.gz: 3cd96f3ceb33c2a028f62b1f72a16196ee1afa3768f0463783262ce3a4bd1d98d85e9ab905a916c0ad27cf7bfaf2c16608c5d533e07c30b6463807122d711f09
+  data.tar.gz: 253aa1b4a8a31c2c323ff05fbad3e2f613b932c82a5f1d61505e92966c1bfe7c593d17bae094f6ebd59b5568433d93d83e443b16df7c75d1b257d1015834a405

data/README.md

@@ -106,6 +106,8 @@ This rule ensures the merge request follows our [Changelog guidelines](https://d
 
 #### `changes_size`
 
+This rule ensures the merge request isn't too big to be reviewed, otherwise it suggests to split the MR.
+
 ##### Available configurations
 
 - `code_size_thresholds`: A hash of the form `{ high: 42, medium: 12 }` where
@@ -119,6 +121,14 @@ This rule ensures the merge request follows our [Changelog guidelines](https://d
 - `max_commits_count`: The maximum number of allowed non-squashed/non-fixup commits for a given MR.
    A warning is triggered if the MR has more commits.
 
+#### `commits_counter`
+
+This rule posts a failure if the merge request has more than 20 commits.
+
+#### `metadata`
+
+This rule ensures basic metadata such as assignee, milestone and description are set on the merge request.
+
 #### `simple_roulette`
 
 The library includes a simplified default reviewer roulette that you can use in your
@@ -230,7 +240,7 @@ Latest documentation can be found at <https://www.rubydoc.info/gems/gitlab-dange
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. 
+To install this gem onto your local machine, run `bundle exec rake install`.
 
 ### Activate lefthook locally
 

data/lib/danger/plugins/changelog.rb

@@ -137,7 +137,7 @@ module Danger
       check_result.warning(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) if helper.revert_mr?
+      check_result.warning(IF_REVERT_MR_TEXT) if helper.revert_mr? && !helper.stable_branch?
 
       add_danger_messages(check_result)
     end

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

@@ -26,8 +26,8 @@ module Danger
       tooling: '~"maintenance::workflow" / ~"maintenance::pipelines" for CI, Danger',
       ci_template: '~"ci::templates"',
       product_intelligence: '~"product intelligence"',
-      integrations_be: '~"group::integrations" (backend)',
-      integrations_fe: '~"group::integrations" (frontend)',
+      import_integrate_be: '~"group::import and integrate" (backend)',
+      import_integrate_fe: '~"group::import and integrate" (frontend)',
       "Authentication and Authorization": '~"group::authentication and authorization"',
       Compliance: '~"group::compliance"',
     }.freeze
@@ -35,6 +35,8 @@ module Danger
 
     GITLAB_ORG_GROUP_ID = "9970"
 
+    STABLE_BRANCH_REGEX = %r{\A(?<version>\d+-\d+)-stable-ee\z}
+
     # Allows to set specific rule's configuration by passing a block.
     #
     # @yield [c] Yield a Gitlab::Dangerfiles::Config object
@@ -278,6 +280,13 @@ module Danger
       gitlab_helper.mr_author
     end
 
+    # @return [Array<Hash>] +[]+ when not in the CI context, and the MR assignees otherwise.
+    def mr_assignees
+      return [] unless ci?
+
+      gitlab_helper.mr_json["assignees"]
+    end
+
     # @return [String] +""+ when not in the CI context, and the MR title otherwise.
     def mr_title
       return "" unless ci?
@@ -285,6 +294,13 @@ module Danger
       gitlab_helper.mr_json["title"]
     end
 
+    # @return [String] +""+ when not in the CI context, and the MR description otherwise.
+    def mr_description
+      return "" unless ci?
+
+      gitlab_helper.mr_body
+    end
+
     # @return [String] +""+ when not in the CI context, and the MR URL otherwise.
     def mr_web_url
       return "" unless ci?
@@ -292,6 +308,13 @@ module Danger
       gitlab_helper.mr_json["web_url"]
     end
 
+    # @return [Hash, nil] +nil+ when not in the CI context, and the MR milestone otherwise.
+    def mr_milestone
+      return unless ci?
+
+      gitlab_helper.mr_json["milestone"]
+    end
+
     # @return [Array<String>] +[]+ when not in the CI context, and the MR labels otherwise.
     def mr_labels
       return [] unless ci?
@@ -348,6 +371,10 @@ module Danger
       mr_web_url.include?("/gitlab-org/security/")
     end
 
+    def stable_branch_mr?
+      !!mr_target_branch.match(STABLE_BRANCH_REGEX) && !security_mr?
+    end
+
     # @return [Boolean] whether a MR title includes "cherry-pick" or not.
     def cherry_pick_mr?
       Gitlab::Dangerfiles::TitleLinting.has_cherry_pick_flag?(mr_title)
@@ -428,11 +455,16 @@ module Danger
       all_changed_files.grep(regex)
     end
 
-    # @return [Array<String>] the group labels (i.e. +"group::*"+) set on the MR.
+    # @return [String] the group label (i.e. +"group::*"+) set on the MR.
     def group_label
       mr_labels.find { |label| label.start_with?("group::") }
     end
 
+    # @return [String] the stage label (i.e. +"devops::*"+) set on the MR.
+    def stage_label
+      mr_labels.find { |label| label.start_with?("devops::") }
+    end
+
     # Accessor for storing labels to add so that other rules can check if labels will be added after Danger
     # has evaluated all the rules.
     # For instance, a rule might require a specific label to be set, but another rule could add this label

data/lib/danger/plugins/roulette.rb

@@ -52,7 +52,7 @@ module Danger
     def spin(project = nil, categories = [:none], timezone_experiment: false)
       project = (project || config_project_name).downcase
       categories = categories.map { |category| category&.downcase || :none }
-      categories.reject! { |category| integrations_reject_category?(category, project) }
+      categories.reject! { |category| import_and_integrate_reject_category?(category, project) }
 
       spins = categories.sort_by(&:to_s).map do |category|
         including_timezone = INCLUDE_TIMEZONE_FOR_CATEGORY.fetch(category, timezone_experiment)
@@ -96,7 +96,7 @@ module Danger
             # Fetch an already picked maintainer, or pick one otherwise
             spin.maintainer = backend_spin&.maintainer || frontend_spin&.maintainer || spin_for_category(project, :backend, timezone_experiment: including_timezone).maintainer
           end
-        when :integrations_be, :integrations_fe
+        when :import_integrate_be, :import_integrate_fe
           spin.optional_role = :maintainer
         when :ux
           spin.optional_role = :maintainer
@@ -173,10 +173,10 @@ module Danger
 
     # @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)
+    def import_and_integrate_reject_category?(category, project)
+      # Reject Import and Integrate categories if the MR author has reviewing abilities for the category.
+      team_mr_author&.import_integrate_be?(project, category, helper.mr_labels) ||
+        team_mr_author&.import_integrate_fe?(project, category, helper.mr_labels)
     end
 
     def random
@@ -267,12 +267,17 @@ module Danger
       rsp = Net::HTTP.get_response(URI.parse(url))
 
       if rsp.is_a?(Net::HTTPRedirection)
-        warnings << "Redirection detected. Stopping."
+        if (uri = URI.parse(rsp.header["location"]))
+          uri.query = nil
+        end
+
+        warnings << "Redirection detected: #{uri}."
         return nil
       end
 
       unless rsp.is_a?(Net::HTTPOK)
-        warnings << "HTTPError: Failed to read #{url}: #{rsp.code}."
+        message = rsp.message[0, 30]
+        warnings << "HTTPError: Failed to read #{url}: #{rsp.code} #{message}."
         return nil
       end
 

data/lib/danger/rules/changes_size/Dangerfile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+return if helper.stable_branch_mr?
+
 thresholds = helper.config.code_size_thresholds
 lines_changed = git.lines_of_code
 

data/lib/danger/rules/commits_counter/Dangerfile

@@ -1,5 +1,31 @@
 # frozen_string_literal: true
 
-if git.commits.size > 20
-  failure 'This MR has more than 20 commits. You need to rebase this branch to have fewer commits.'
+gitlab_org_gitlab_project_id = 278964
+
+return if git.commits.size <= 20
+
+general_message = 'This merge request has more than 20 commits which may cause issues in some of the jobs. If you see errors like missing commits'
+
+warning_message = "#{general_message}, please consider squashing some commits so it is within 20 commits."
+
+failure_message = "#{general_message}, please enable squashing and consider squashing yourself as well."
+
+# GitLab the project has quite some jobs relying on having less than 20
+# commits due to GIT_DEPTH being set to 20. Those jobs require accessing to
+# all the commits within the merge request thus it cannot have more than that.
+# We also have a higher commit history standard for a larger project like that
+# See also:
+#
+# https://gitlab.com/gitlab-org/gitlab/-/issues/358125
+# https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/issues/49
+if helper.mr_target_project_id == gitlab_org_gitlab_project_id
+  details = "See [comments in the file](https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/blob/master/lib/danger/rules/commits_counter/Dangerfile) implementing this for more details."
+
+  if helper.squash_mr?
+    warn "#{warning_message} #{details}"
+  else
+    failure "#{failure_message} #{details}"
+  end
+else
+  warn warning_message
 end

data/lib/danger/rules/metadata/Dangerfile

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+fail("Merge request description is too short. Please provide a proper merge request description.") if helper.mr_description.size < 5 # rubocop:disable Style/SignalException:
+
+warn("This merge request does not have any assignee yet. Setting an assignee clarifies who needs to take action on the merge request at any given time.") if helper.mr_assignees.empty?
+
+warn("This merge request does not refer to an existing milestone.", sticky: false) if helper.mr_milestone.nil?

data/lib/gitlab/dangerfiles/category.rb

@@ -14,8 +14,8 @@ module Gitlab
           none: None,
           test: Test,
           tooling: Tooling,
-          integrations_be: IntegrationsBE,
-          integrations_fe: IntegrationsFE,
+          import_integrate_be: ImportIntegrateBE,
+          import_integrate_fe: ImportIntegrateFE,
           ux: UX,
         }.freeze
       end
@@ -71,7 +71,7 @@ module Gitlab
         end
       end
 
-      class IntegrationsBE < Category
+      class ImportIntegrateBE < Category
         private
 
         def has_particular_capability?(teammate)
@@ -80,7 +80,7 @@ module Gitlab
         end
       end
 
-      class IntegrationsFE < Category
+      class ImportIntegrateFE < Category
         private
 
         def has_particular_capability?(teammate)

data/lib/gitlab/dangerfiles/teammate.rb

@@ -55,14 +55,14 @@ module Gitlab
         has_capability?(project, category, :maintainer, labels)
       end
 
-      def integrations_be?(project, category, labels)
-        return false unless category == :integrations_be
+      def import_integrate_be?(project, category, labels)
+        return false unless category == :import_integrate_be
 
         has_capability?(project, category, :reviewer, labels)
       end
 
-      def integrations_fe?(project, category, labels)
-        return false unless category == :integrations_fe
+      def import_integrate_fe?(project, category, labels)
+        return false unless category == :import_integrate_fe
 
         has_capability?(project, category, :reviewer, labels)
       end

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "3.7.0"
+    VERSION = "3.9.0"
   end
 end

data/lib/gitlab/dangerfiles.rb

@@ -5,6 +5,7 @@ module Gitlab
   module Dangerfiles
     RULES_DIR = File.expand_path("../danger/rules", __dir__)
     CI_ONLY_RULES = %w[
+      metadata
       simple_roulette
       type_label
       subtype_label

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.9.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -174,6 +174,7 @@ files:
 - lib/danger/rules/changes_size/Dangerfile
 - lib/danger/rules/commit_messages/Dangerfile
 - lib/danger/rules/commits_counter/Dangerfile
+- lib/danger/rules/metadata/Dangerfile
 - lib/danger/rules/simple_roulette/Dangerfile
 - lib/danger/rules/subtype_label/Dangerfile
 - lib/danger/rules/type_label/Dangerfile