gitlab-dangerfiles 3.9.0 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5759d8762183090115e7cb10b4b2d7244735d3225b53966c8feaf28e9d9eee7e
-  data.tar.gz: f49d06c663430072bad4c4f05b8bd1f509ca2c1a095bd1e499e3870fbe061fc9
+  metadata.gz: 2ee27fb91564bfb45f28aed3fca576c6731c91ae9f69719e2ebb0ce5807ff1ee
+  data.tar.gz: 3bcd268c5fc1a91141a447ff6bb1b0c63841fe4dab2c65fffc61c7c488048275
 SHA512:
-  metadata.gz: 3cd96f3ceb33c2a028f62b1f72a16196ee1afa3768f0463783262ce3a4bd1d98d85e9ab905a916c0ad27cf7bfaf2c16608c5d533e07c30b6463807122d711f09
-  data.tar.gz: 253aa1b4a8a31c2c323ff05fbad3e2f613b932c82a5f1d61505e92966c1bfe7c593d17bae094f6ebd59b5568433d93d83e443b16df7c75d1b257d1015834a405
+  metadata.gz: d5cab2d3171779a9f28c00452e4e0435a6aa93852d80847b4da3b03f38fe294e7c855232b1402d6f3ac14f99b04518993b5fb6401da928ed9189f86a44948769
+  data.tar.gz: dc580aa4781087b6598c8d4f2befb2fec6b9d87ae4ce964227b35a4fbc537c62f2bad0e4d947a65154753157a896cb890472be33d99f0e15463d63beed17b6ee

data/.gitlab/merge_request_templates/Release.md

@@ -2,7 +2,7 @@
 commit from this merge request, and `<NEW_VERSION>` with the upcoming version number. -->
 ## Diff
 
-https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/compare/v<PREVIOUS_VERSION>...<COMMIT_UPDATING_VERSION>
+https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/compare/v<PREVIOUS_VERSION>...<COMMIT_UPDATING_VERSION>
 
 ## Checklist
 

data/README.md

@@ -218,17 +218,32 @@ danger-review:
     - bundle add gitlab-dangerfiles --version 3.1.0
 ```
 
-## Rake tasks
+## Local Danger Rake task
 
-You can import this gem's Rake tasks by adding the following to your project's `Rakefile`:
+You can run a Danger Rake task locally in a project to detect Danger errors before pushing commits to a remote
+branch.
 
-```ruby
-require 'gitlab-dangerfiles'
+1. [Install `gitlab-dangerfiles`](#installation) in your project.
+1. Add the following to your project's `Rakefile`:
+
+   ```ruby
+   require 'gitlab-dangerfiles'
+
+   Gitlab::Dangerfiles.load_tasks
+   ```
+
+To run the Danger Rake task in a project that has `master` as the default branch, run:
 
-Gitlab::Dangerfiles.load_tasks
+```shell
+bundle exec rake danger_local
 ```
 
-That will add the `danger_local` Rake task that allows to run Danger locally.
+To run the Danger Rake task in a project that doesn't have `master` as the default branch, you must set the
+`DANGER_LOCAL_BASE` environment variable. For example, in a project with `main` as the default branch:
+
+```shell
+DANGER_LOCAL_BASE="origin/main" bundle exec rake danger_local
+```
 
 ## Documentation
 
@@ -264,6 +279,12 @@ end
 
 See an [example](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92580) for more details.
 
+## Contributing
+
+Bug reports and merge requests are welcome at https://gitlab.com/gitlab-org/gitlab-dangerfiles. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/gitlab-org/gitlab-dangerfiles/blob/master/CODE_OF_CONDUCT.md).
+
+Make sure to include a changelog entry in your commit message and read the [changelog entries section](https://docs.gitlab.com/ee/development/changelog.html).
+
 ## Release
 
 [Automated gem release process](https://gitlab.com/gitlab-org/quality/pipeline-common#release-process) is used to release new version of `gitlab-dangerfiles` through [pipelines](https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/blob/4f33cf30cab84f7e27ca0cb9a7c0da3ecc675c11/.gitlab-ci.yml#L51), and this will:
@@ -272,24 +293,22 @@ See an [example](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92580) fo
 - Add a release in the `gitlab-dangerfiles` project: https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/releases
 - Populate the release log with the API contents. For example: https://gitlab.com/api/v4/projects/19861191/repository/changelog?version=3.4.4
 
+We follow this release process in a separate merge request from the one that introduced the changes. The release merge request should just contain a version bump.
+
 ### Before release
 
-Make sure to include a changelog entry in your commit message and read the [changelog entries section](https://docs.gitlab.com/ee/development/changelog.html).
+Changes merged since the last release should have had changelog entries (see [Contributing](#contributing)).
 
-If you forget to set the changelog entry in your commit messages, you can also edit the release notes after it's being released.
+If changelog entries are missing, you can also edit the release notes after it's being released.
 
 ### Steps to release
 
-Use a `Release` merge request template and create a merge requet to update the version number in `version.rb`, and get the merge request merged by a maintainer.
+Use a `Release` merge request template and create a merge request to update the version number in `version.rb`, and get the merge request merged by a maintainer.
 
 This will then be packaged into a gem and pushed to [rubygems.org](https://rubygems.org) by the CI/CD.
 
 For example: [Bump version to 3.4.3](https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/merge_requests/149).
 
-## Contributing
-
-Bug reports and merge requests are welcome at https://gitlab.com/gitlab-org/gitlab-dangerfiles. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://gitlab.com/gitlab-org/gitlab-dangerfiles/blob/master/CODE_OF_CONDUCT.md).
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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

@@ -25,7 +25,7 @@ module Danger
       engineering_productivity: '~"Engineering Productivity" for CI, Danger',
       tooling: '~"maintenance::workflow" / ~"maintenance::pipelines" for CI, Danger',
       ci_template: '~"ci::templates"',
-      product_intelligence: '~"product intelligence"',
+      analytics_instrumentation: '~"analytics instrumentation"',
       import_integrate_be: '~"group::import and integrate" (backend)',
       import_integrate_fe: '~"group::import and integrate" (frontend)',
       "Authentication and Authorization": '~"group::authentication and authorization"',

data/lib/danger/plugins/roulette.rb

@@ -33,6 +33,34 @@ module Danger
       end
     end
 
+    def prepare_categories(changes_keys)
+      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 labels.include?("database")
+
+      # Ensure to spin for Analytics Instrumentation reviewer when ~"analytics instrumentation::review pending" is applied
+      categories << :analytics_instrumentation if labels.include?("analytics instrumentation::review pending")
+
+      # Skip Analytics Instrumentation reviews for growth experiment MRs
+      categories.delete(:analytics_instrumentation) if labels.include?("growth experiment")
+
+      prepare_ux_category!(categories) if labels.include?("UX")
+
+      # Remove disabled categories
+      categories.subtract(helper.config.disabled_roulette_categories)
+
+      categories
+    end
+
+    def assign_pedroms_for_ux_wider_community_contribution(spins)
+      # We want at least a UX reviewer who can review any wider community
+      # contribution even without a team designer. We assign this to Pedro.
+      ux_spin = look_for_fallback_designer_for_ux_wider_community_contribution?(spins)
+
+      ux_spin && ux_spin.reviewer = teammate_pedroms
+    end
+
     # Finds the +Gitlab::Dangerfiles::Teammate+ object whose username matches the MR author username.
     #
     # @return [Gitlab::Dangerfiles::Teammate]
@@ -89,7 +117,7 @@ module Danger
             # Fetch an already picked backend maintainer, or pick one otherwise
             spin.maintainer = backend_spin&.maintainer || spin_for_category(project, :backend, timezone_experiment: including_timezone).maintainer
           end
-        when :product_intelligence
+        when :analytics_instrumentation
           spin.optional_role = :maintainer
 
           if spin.maintainer.nil?
@@ -124,6 +152,10 @@ module Danger
       @warnings ||= []
     end
 
+    def teammate_pedroms
+      @teammate_pedroms ||= find_member("pedroms")
+    end
+
     private
 
     def spin_for_approval_rule?(rule)
@@ -175,8 +207,8 @@ module Danger
     # @return [Boolean]
     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)
+      team_mr_author&.import_integrate_be?(project, category, labels) ||
+        team_mr_author&.import_integrate_fe?(project, category, labels)
     end
 
     def random
@@ -185,7 +217,7 @@ module Danger
 
     def spin_role_for_category(team, role, project, category)
       team.select do |member|
-        member.public_send("#{role}?", project, category, helper.mr_labels)
+        member.public_send("#{role}?", project, category, labels)
       end
     end
 
@@ -258,6 +290,38 @@ module Danger
       Spin.new(category, reviewer, maintainer, false, timezone_experiment)
     end
 
+    def prepare_ux_category!(categories)
+      # Ensure to spin for UX reviewer when ~UX is applied (e.g. to review changes to the UI)
+      if labels.include?("Community contribution")
+        categories << :ux
+      else
+        begin
+          # We only want to spin a reviewer for merge requests which has a
+          # designer for the team. There's no easy way to tell this, so we
+          # pretend this is a community contribution, in which case we only
+          # pick the team designer. If there's no one got picked, it means
+          # there's no designer for this team.
+          labels << "Community contribution"
+
+          ux_spin = spin(nil, [:ux]).first
+
+          categories << :ux if ux_spin.reviewer || ux_spin.maintainer
+        ensure
+          # Make sure we delete the label afterward
+          labels.delete("Community contribution")
+        end
+      end
+    end
+
+    def look_for_fallback_designer_for_ux_wider_community_contribution?(spins)
+      labels.include?("Community contribution") &&
+        spins.find do |spin|
+          spin.category == :ux &&
+            spin.reviewer.nil? &&
+            spin.maintainer.nil?
+        end
+    end
+
     # Fetches the given +url+ and parse its response as JSON.
     #
     # @param [String] url
@@ -316,14 +380,20 @@ module Danger
       helper.config.project_name
     end
 
+    # Return the labels from the merge requests. This is cached.
+    #
+    # @return [String]
+    def labels
+      @labels ||= helper.mr_labels
+    end
+
     # Like +team+, but only returns teammates in the current project, based on
     # project_name.
     #
     # @return [Array<Gitlab::Dangerfiles::Teammate>]
     def project_team(project_name)
       company_members.select do |member|
-        member.in_project?(project_name) ||
-          member.in_project?("gitlab") # Used for universal reviewer
+        member.in_project?(project_name)
       end
     rescue => err
       warn("Reviewer roulette failed to load team data: #{err.message}")

data/lib/danger/rules/simple_roulette/Dangerfile

@@ -81,30 +81,16 @@ def warning_list(roulette)
 end
 
 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)
-
-# 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')
-
-# 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")
-
-# Remove disabled categories
-categories.subtract(helper.config.disabled_roulette_categories)
+categories = roulette.prepare_categories(changes.keys)
 
 if changes.any?
   show_category_column = categories.size > 1 || categories.first != :none
   random_roulette_spins = roulette.spin(nil, categories)
 
+  if categories.include?(:ux)
+    roulette.assign_pedroms_for_ux_wider_community_contribution(random_roulette_spins)
+  end
+
   rows = random_roulette_spins.map do |spin|
     markdown_row_for_spins(spin.category, [spin], show_category_column: show_category_column)
   end

data/lib/gitlab/dangerfiles/category.rb

@@ -21,19 +21,11 @@ module Gitlab
       end
       private_class_method :name_to_class
 
-      def has_capability?(...)
-        has_particular_capability?(...) || has_universal_capability?(...)
-      end
-
-      private
-
-      def has_particular_capability?(teammate)
+      def has_capability?(teammate)
         teammate.capabilities(project).include?(capability)
       end
 
-      def has_universal_capability?(teammate)
-        false
-      end
+      private
 
       def capability
         @capability ||= "#{kind} #{name}"
@@ -46,21 +38,17 @@ module Gitlab
       end
 
       class Test < Category
-        private
-
-        def has_particular_capability?(teammate)
+        def has_capability?(teammate)
           return false if kind != :reviewer
 
           area = teammate.role[/Software Engineer in Test(?:.*?, (\w+))/, 1]
 
-          area && labels.any?("devops::#{area.downcase}")
+          !!area && labels.any?("devops::#{area.downcase}")
         end
       end
 
       class Tooling < Category
-        private
-
-        def has_particular_capability?(teammate)
+        def has_capability?(teammate)
           if super
             true
           elsif %i[trainee_maintainer maintainer].include?(kind)
@@ -72,59 +60,52 @@ module Gitlab
       end
 
       class ImportIntegrateBE < Category
-        private
-
-        def has_particular_capability?(teammate)
+        def has_capability?(teammate)
           kind == :reviewer &&
-            teammate.role.match?(/Backend Engineer.+Manage:Integrations/)
+            teammate.role.match?(/Backend Engineer.+Manage:Import and Integrate/)
         end
       end
 
       class ImportIntegrateFE < Category
-        private
-
-        def has_particular_capability?(teammate)
+        def has_capability?(teammate)
           kind == :reviewer &&
-            teammate.role.match?(/Frontend Engineer.+Manage:Integrations/)
+            teammate.role.match?(/Frontend Engineer.+Manage:Import and Integrate/)
         end
       end
 
       class UX < Category
+        def has_capability?(teammate)
+          super &&
+
+            if labels.any?("Community contribution")
+              can_review_wider_community_contribution?(teammate)
+            else
+              can_review_team_memeber_contribution?(teammate)
+            end
+        end
+
         private
 
-        def has_particular_capability?(teammate)
-          if labels.any?("Community contribution")
-            can_review_wider_community_contribution?(teammate)
-          else
-            super
-          end
+        def can_review_wider_community_contribution?(teammate)
+          # We want the designer for the team to review the wider community
+          # contribution because they're more familiar with that area.
+          the_designer_for_the_team?(teammate)
         end
 
-        def has_universal_capability?(teammate)
-          # No universal reviewer for community contribution.
-          # If we do, then picking from corresponding group won't be accurate.
-          # After solving the following issue, then we can revisit this:
-          # https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles/-/issues/58
-          return false if labels.any?("Community contribution")
-
-          teammate.projects.each_value.any? do |capabilities|
-            capabilities.include?(capability)
-          end
+        def can_review_team_memeber_contribution?(teammate)
+          # We don't want the designer for the team to review merge
+          # requests for the same team which is designed by themselves.
+          # So they can only review if they're not the designer for the team.
+          !the_designer_for_the_team?(teammate)
         end
 
-        def can_review_wider_community_contribution?(teammate)
+        def the_designer_for_the_team?(teammate)
           # Pick corresponding group for community contribution
-          # Role can be:
-          # Product Designer, Create:Source Code
-          # Product Designer, Verify:Pipeline Insights, Verify:Runner
-          # Product Designer, Release
           # Specialty can be:
           # Source Code
           # [Growth: Activation, Growth: Expansion]
           # Runner
-          areas = teammate.role[/Product Designer(?:.*?, (.+))/, 1]&.split(",")
-
-          group_labels = [*teammate.specialty, *areas].map do |field|
+          group_labels = Array(teammate.specialty).map do |field|
             group = field.strip.sub(/^.+: ?/, "").downcase
 
             "group::#{group}"

data/lib/gitlab/dangerfiles/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 3.9.0
+  version: 3.11.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-02 00:00:00.000000000 Z
+date: 2023-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake