gitlab-dangerfiles 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c8b3755415a3a732fc13c70da4176927062a9d5b6452a7d2513d3ef29617c89
-  data.tar.gz: 1822e18dcc9e51d93f0ea1f3df574aaf5c1dd5ec1b0fd552bfea34f8b114971d
+  metadata.gz: fcee2fd2dd96522a7b1a5d1f906bc7fccfa28c9d6e9f61d6843c1fcd22dee884
+  data.tar.gz: c433e7fd8d3fd698c1eb71e5291f24a191ee2c4a86d376bae6f18b0735352f2a
 SHA512:
-  metadata.gz: d86af6131e0703fcab736fb75f09b62d1e656bec379f76f8bee6223899e99b34a085c86dc94d7c6d99ce88642acbea4d9079050ab50331abbc10d6c47c0fcc76
-  data.tar.gz: dc878dcd339bed44e0cb4059ec965cce1f6e0513099002126779640c3f8986417bbfabdbbec1ffd4137729839d682d8f7bc6f69cf1654ee03b9a75007f561f93
+  metadata.gz: c014e0cf3905380549a0f088c5685b7e1251643f5bbdd3e5362e4cf3c0ca0c0e4a1456599db66eabd3dad006547b70010716a2ab5b9aa2318e573ced7bd3680d
+  data.tar.gz: 0311fcec0f9cd30684470739798c5ab9c296d2c3cfb22d7e73a98f2c644b6db373edd752587a134199a366372b877bca4d3f198aed89f133483db45a2d5979e6

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

@@ -278,6 +278,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 +292,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 +306,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?

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,11 @@
+# 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?
+
+default_branch = ENV['CI_DEFAULT_BRANCH'] || 'main'
+has_pick_into_stable_label = helper.mr_labels.find { |label| label.start_with?('Pick into') }
+warn("Most of the time, merge requests should target `#{default_branch}`. Otherwise, please set the relevant `Pick into X.Y` label.") if helper.mr_target_branch != default_branch && !has_pick_into_stable_label && !helper.security_mr?

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "3.7.0"
+    VERSION = "3.8.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.8.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-02-15 00:00:00.000000000 Z
+date: 2023-03-03 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