gitlab-dangerfiles 3.0.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bcd8631096b4c3a5c7c6df1c8a1c49fda0a4b4936c9f815996ca7702be99f3e
-  data.tar.gz: ce6a7cc2c2b69e49a262882eddba550d4245c578bfc235be594a27cd0d04d737
+  metadata.gz: bf965c37aaf01dff0630442feecb4fbe6e8d96bb2c9f7f714c631487c9eb894e
+  data.tar.gz: 720fe1ddfd202e0b199dfbd63fdb360a8a7e58d355182b7055ff0fdebb74c886
 SHA512:
-  metadata.gz: 60b36a45528577103064018e02315f365f729c4842f77ef794001fe4697760f2baf60ecaf29a19c5a1c0be25c239832b5d93908a4d6ddb5df7dc22380968f317
-  data.tar.gz: f1591f53f037986f147f9549bfe98faeecee825c20d916e4370d9f76d562a18456fe8ac993e507987013bdaa52b95845776bac3c66fe6ab844d2f74b13084339
+  metadata.gz: 31a832aa516290296662a7949b01a13c7dd47e7c05ad6c6e78cb1f189f2190b99094e97a07875d65f4cb6b5504a8816d1a26aa39a618480899f2026c58c2c311
+  data.tar.gz: 4f18f92c83494aff49ceec1a05f2b380bd9be7aee17a50a4126ec25c011cfc468a672da200d4a93420d4c47bbec19d6678dc389e083a56945d94d52a58862107

data/README.md

@@ -135,7 +135,9 @@ project. To use it in your project, perform the following steps:
 
 #### `type_label`
 
-This rule ensures the merge request has a proper [type label](https://about.gitlab.com/handbook/engineering/metrics/#work-type-classification) set.
+This rule warns when the merge request is missing a [type label](https://about.gitlab.com/handbook/engineering/metrics/#work-type-classification).
+
+If the `DANGER_ERROR_WHEN_TYPE_LABEL_IS_MISSING` environment variable evaluates to `true`, Danger will error when a type label is missing.
 
 If the `changelog` plugin is available, it also tries to infer a type label from the `Changelog` trailer of the MR.
 
@@ -170,6 +172,31 @@ include:
 
 See a [real world example](https://gitlab.com/gitlab-org/ruby/gems/gitlab-styles/-/merge_requests/105).
 
+#### Without `Gemfile`
+
+Danger is a Ruby project and uses [`bundler`](https://bundler.io/) to manage
+its dependencies. This requires a project to have a `Gemfile` and
+`Gemfile.lock` commited. This is helpful especially if Danger is also used
+locally - with `lefthook`, for example.
+
+In order to skip Ruby and `bundler` dependency in a project, use `bundle` commands directly
+in the CI configuration:
+
+```yaml
+include:
+  - project: 'gitlab-org/quality/pipeline-common'
+    file: '/ci/danger-review.yml'
+
+danger-review:
+  before_script:
+    - bundle init
+    # For latest version
+    - bundle add gitlab-dangerfiles
+    # OR
+    # For a pinned version
+    - bundle add gitlab-dangerfiles --version 3.1.0
+```
+
 ## Rake tasks
 
 You can import this gem's Rake tasks by adding the following to your project's `Rakefile`:
@@ -190,7 +217,9 @@ 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 release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+To install this gem onto your local machine, run `bundle exec rake install`. 
+
+To release a new version, update the version number in `version.rb`, and get the MR merged by a maintainer. This will be then be packaged into a gem and pushed to [rubygems.org](https://rubygems.org) by the CI/CD.
 
 ## Contributing
 

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

@@ -17,7 +17,7 @@ module Danger
       none: "",
       qa: "~QA",
       ux: "~UX",
-      test: "~test ~Quality for `spec/features/*`",
+      test: "~test for `spec/features/*`",
       # Deprecated as of 2.3.0 in favor of tooling
       engineering_productivity: '~"Engineering Productivity" for CI, Danger',
       tooling: '~"maintenance::workflow" / ~"maintenance::pipelines" for CI, Danger',

data/lib/danger/plugins/roulette.rb

@@ -192,7 +192,10 @@ module Danger
     #
     # @return [Array<Gitlab::Dangerfiles::Teammate>]
     def project_team(project_name)
-      company_members.select { |member| member.in_project?(project_name) }
+      company_members.select do |member|
+        member.in_project?(project_name) ||
+          member.in_project?("gitlab") # Used for backup reviewer
+      end
     rescue => err
       warn("Reviewer roulette failed to load team data: #{err.message}")
       []

data/lib/danger/rules/commits_counter/Dangerfile

@@ -0,0 +1,5 @@
+# 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.'
+end

data/lib/danger/rules/simple_roulette/Dangerfile

@@ -60,37 +60,44 @@ 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)
+def markdown_row_for_spins(category = nil, spins_array, has_categories:)
   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 categories_defined?
-
+  row.prepend("| #{helper.label_for_category(category)} ") if has_categories
   row
 end
 
-def categories_defined?
-  helper.config.files_to_category.any?
-end
+changes = helper.changes_by_category
 
-def categories(changes)
-  categories_defined? ? changes.keys : [nil]
-end
+# Replicating label based categories from:
+# https://gitlab.com/gitlab-org/gitlab/-/blob/master/danger/roulette/Dangerfile
+categories = Set.new(changes.keys - [:unknown])
 
-def table_header
-  categories_defined? ? TABLE_HEADER_WITH_CATEGORIES : TABLE_HEADER_WITHOUT_CATEGORIES
-end
+# 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')
 
-changes = helper.changes_by_category
+# Ensure to spin for UX reviewer when ~UX is applied (e.g. to review changes to the UI) except when it's from wider community contribution where we want to assign from the corresponding group
+categories << :ux if helper.mr_labels.include?('UX') && !helper.mr_labels.include?('Community contribution')
+
+# Ensure to spin for Product Intelligence reviewer when ~"product intelligence::review pending" is applied
+categories << :product_intelligence if helper.mr_labels.include?("product intelligence::review pending")
+
+# Skip Product intelligence reviews for growth experiment MRs
+categories.delete(:product_intelligence) if helper.mr_labels.include?("growth experiment")
 
 if changes.any?
-  random_roulette_spins = roulette.spin(nil, categories(changes))
+  has_categories = categories.any?
+  categories = [nil] unless has_categories
+  random_roulette_spins = roulette.spin(nil, categories)
 
   rows = random_roulette_spins.map do |spin|
-    markdown_row_for_spins(spin.category, [spin])
+    markdown_row_for_spins(spin.category, [spin], has_categories: has_categories)
   end
 
+  table_header = has_categories ? TABLE_HEADER_WITH_CATEGORIES : TABLE_HEADER_WITHOUT_CATEGORIES
+
   markdown(MESSAGE)
   markdown(TABLE_MARKDOWN + table_header + rows.join("\n")) unless rows.empty?
 end

data/lib/danger/rules/type_label/Dangerfile

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+TYPE_LABEL_MISSING_MESSAGE = "Please add a [merge request type](https://about.gitlab.com/handbook/engineering/metrics/#work-type-classification) to this merge request."
+
 require_relative "../../../gitlab/dangerfiles/type_label_guesser"
 
 if respond_to?(:changelog) && !helper.has_scoped_label_with_scope?("type")
@@ -7,6 +9,10 @@ if respond_to?(:changelog) && !helper.has_scoped_label_with_scope?("type")
   helper.labels_to_add.concat(type_label_guesser.labels_from_changelog_categories(changelog.categories))
 end
 
-unless helper.has_scoped_label_with_scope?("type")
-  warn "Please add a [merge request type](https://about.gitlab.com/handbook/engineering/metrics/#work-type-classification) to this merge request."
+return if helper.has_scoped_label_with_scope?("type")
+
+if ENV["DANGER_ERROR_WHEN_TYPE_LABEL_IS_MISSING"]
+  fail TYPE_LABEL_MISSING_MESSAGE
+else
+  warn TYPE_LABEL_MISSING_MESSAGE
 end

data/lib/gitlab/dangerfiles/teammate.rb

@@ -130,11 +130,22 @@ module Gitlab
           capabilities(project).include?("#{kind}")
         else
           capabilities(project).include?("#{kind} #{category}")
+        end || has_backup_capability?(category, kind, labels)
+      end
+
+      def has_backup_capability?(category, kind, labels)
+        case category
+        when :ux
+          capacity = "#{kind} #{category}"
+
+          projects.each_value.find do |capabilities|
+            capabilities.include?(capacity)
+          end
         end
       end
 
       def capabilities(project)
-        Array(projects.fetch(project, []))
+        projects.fetch(project, [])
       end
 
       def pluralize(count, singular, plural)

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "3.0.0"
+    VERSION = "3.3.0"
   end
 end

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

@@ -13,15 +13,15 @@ module Gitlab
       # | reduced capacity reviewer    |                              1 |
       # | reviewer                     |                              2 |
       # | hungry reviewer              |                              4 |
-      # | reduced capacity traintainer |                              3 |
-      # | traintainer                  |                              6 |
-      # | hungry traintainer           |                              8 |
+      # | reduced capacity traintainer |                              1 |
+      # | traintainer                  |                              2 |
+      # | hungry traintainer           |                              6 |
       # +------------------------------+--------------------------------+
       #
       # @api private
       class Reviewers
         DEFAULT_REVIEWER_WEIGHT = Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER * Gitlab::Dangerfiles::Weightage::BASE_REVIEWER_WEIGHT
-        TRAINTAINER_WEIGHT = 3
+        TRAINTAINER_WEIGHT = 2
 
         def initialize(reviewers, traintainers)
           @reviewers = reviewers
@@ -32,6 +32,8 @@ module Gitlab
           # TODO: take CODEOWNERS into account?
           # https://gitlab.com/gitlab-org/gitlab/issues/26723
 
+          remove_traintainers_from_reviewers!
+
           weighted_reviewers + weighted_traintainers
         end
 
@@ -39,25 +41,33 @@ module Gitlab
 
         attr_reader :reviewers, :traintainers
 
+        def remove_traintainers_from_reviewers!
+          # Sometimes folks will add themselves as traintainers and not remove themselves as reviewers.
+          # There seems no way currently to ensure only one of these entries exists for a person.
+          # We need to protect ourselves from that scenario here as the code assumes a reviewer will only
+          # appear in reviewers or traintainers, not both.
+          reviewers.reject! { |reviewer| traintainers.include?(reviewer) }
+        end
+
         def weighted_reviewers
           reviewers.each_with_object([]) do |reviewer, total_reviewers|
-            add_weighted_reviewer(total_reviewers, reviewer, Gitlab::Dangerfiles::Weightage::BASE_REVIEWER_WEIGHT)
+            add_weighted_reviewer(total_reviewers, reviewer, DEFAULT_REVIEWER_WEIGHT)
           end
         end
 
         def weighted_traintainers
           traintainers.each_with_object([]) do |reviewer, total_traintainers|
-            add_weighted_reviewer(total_traintainers, reviewer, TRAINTAINER_WEIGHT)
+            add_weighted_reviewer(total_traintainers, reviewer, DEFAULT_REVIEWER_WEIGHT + TRAINTAINER_WEIGHT)
           end
         end
 
-        def add_weighted_reviewer(reviewers, reviewer, weight)
+        def add_weighted_reviewer(reviewers, reviewer, added_weight_for_hungry)
           if reviewer.reduced_capacity
-            reviewers.fill(reviewer, reviewers.size, weight)
+            reviewers.fill(reviewer, reviewers.size, Gitlab::Dangerfiles::Weightage::BASE_REVIEWER_WEIGHT)
           elsif reviewer.hungry
-            reviewers.fill(reviewer, reviewers.size, weight * Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER + DEFAULT_REVIEWER_WEIGHT)
+            reviewers.fill(reviewer, reviewers.size, DEFAULT_REVIEWER_WEIGHT + added_weight_for_hungry)
           else
-            reviewers.fill(reviewer, reviewers.size, weight * Gitlab::Dangerfiles::Weightage::CAPACITY_MULTIPLIER)
+            reviewers.fill(reviewer, reviewers.size, DEFAULT_REVIEWER_WEIGHT)
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.3.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-22 00:00:00.000000000 Z
+date: 2022-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -169,6 +169,7 @@ files:
 - lib/danger/rules/changelog/Dangerfile
 - lib/danger/rules/changes_size/Dangerfile
 - lib/danger/rules/commit_messages/Dangerfile
+- lib/danger/rules/commits_counter/Dangerfile
 - lib/danger/rules/simple_roulette/Dangerfile
 - lib/danger/rules/type_label/Dangerfile
 - lib/danger/rules/z_add_labels/Dangerfile