gitlab-dangerfiles 3.4.3 → 3.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '098225565fa51922d5b158fa2da0a4e3aa7420c3fca45e3acee1c3b3cfaa1ba0'
-  data.tar.gz: ca80ccfdc03823eff324d59faff1eac19ed1e93798ff0833feef5d7b414c5e45
+  metadata.gz: 7263e8c2ab6ba97b10b3cddc96ff91061cd526aa90992a7bd2df469b37e5e217
+  data.tar.gz: e9b2cabb3d6819af138c2080dbca5658f404e6d7f8a71e7f51944bc32e350fde
 SHA512:
-  metadata.gz: cae6d044924941d20f295da7b5b01aa77ba848a5a87c3894e5c9d8e0894499bdfd03425be5412960daa3724eba5dad11f3f3be02ee8dff80e83ca3b503a86f5f
-  data.tar.gz: 4903888e704177bb13b9ba3d5a207201ae703bebe047fc4f9f27483f36ba4f0aa5af2c5e5a5d72478c67c51a06319046bb1ba6f6bad52ba14cb18642f178972e
+  metadata.gz: e28612c099a81ec122a31d475880f121833741375bab94004ee647cb6ae467b074b53c07156ad4a25f361b72e9cfc54bc157b8f64ac8cc42ce4ac0b631efa229
+  data.tar.gz: a37e350cfc9bcb13277801fa72a9a7c5a92028004e02293c34a0c69b03e3d51d6a8359480bb9a716fc5ac27f2b17ae6375dcfe239217f66eab14411949f50c0c

data/.gitlab-ci.yml

@@ -63,11 +63,6 @@ gemnasium-dependency_scanning:
     - if: '$CI_MERGE_REQUEST_IID'
     - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
 
-bundler-audit-dependency_scanning:
-  rules:
-    - if: '$CI_MERGE_REQUEST_IID'
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-
 license_scanning:
   rules:
     - if: '$CI_MERGE_REQUEST_IID'

data/.gitpod.yml

@@ -0,0 +1,2 @@
+tasks:
+  - init: bin/setup

data/README.md

@@ -133,11 +133,17 @@ project. To use it in your project, perform the following steps:
    end
    ```
 
+#### `subtype_label`
+
+This rule warns when the merge request is missing a [subtype label](https://about.gitlab.com/handbook/engineering/metrics/#work-type-classification).
+
+If the `DANGER_ERROR_WHEN_SUBTYPE_LABEL_IS_MISSING` environment variable evaluates to `true`, Danger will error instead of warning when a subtype label is missing.
+
 #### `type_label`
 
 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 `DANGER_ERROR_WHEN_TYPE_LABEL_IS_MISSING` environment variable evaluates to `true`, Danger will error instead of warning 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.
 
@@ -221,13 +227,50 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 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.
-
 ### Activate lefthook locally
 
 ```shell
 lefthook install
 ```
+
+### Testing unreleased changes in merge requests
+
+To test an unreleased change in an actual merge request, you can create a merge request that will install the unreleased version of `gitlab-dangerfiles`. Bundler can install gems by specifying a repository and a revision from Git.
+
+For example, to test `gitlab-dangerfiles` changes from the `your-branch-name` branch in [`gitlab-org/gitlab`](https://gitlab.com/gitlab-org/gitlab), in the `Gemfile`:
+
+```ruby
+group :development, :test, :danger do
+  gem 'gitlab-dangerfiles', '~> 3.4.3', require: false,
+  git: 'https://gitlab.com/gitlab-org/ruby/gems/gitlab-dangerfiles.git',
+  ref: 'your-branch-name'
+end
+```
+
+See an [example](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92580) for more details.
+
+## 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:
+
+- Publish the gem: https://rubygems.org/gems/gitlab-dangerfiles
+- 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
+
+### 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).
+
+If you forget to set the changelog entry in your commit messages, 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.
+
+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).

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

@@ -234,7 +234,7 @@ module Danger
     # @return [String] the GFM for a category label, making its best guess if it's not
     #   a category we know about.
     def label_for_category(category)
-      CATEGORY_LABELS.fetch(category, "~#{category}")
+      CATEGORY_LABELS.fetch(category, %Q{~"#{category}"})
     end
 
     # @return [String] +""+ when not in the CI context, and the MR Source Project ID as a string otherwise.

data/lib/danger/plugins/roulette.rb

@@ -43,7 +43,7 @@ module Danger
     #
     # @return [Array<Spin>]
     def spin(project = nil, categories = [nil], timezone_experiment: false)
-      project = (project || helper.config.project_name).downcase
+      project = (project || config_project_name).downcase
       categories = categories.map { |category| category&.downcase }
       categories.reject! { |category| integrations_reject_category?(category, project) }
 
@@ -90,6 +90,8 @@ module Danger
           end
         when :integrations_be, :integrations_fe
           spin.optional_role = :maintainer
+        when :ux
+          spin.optional_role = :maintainer
         end
       end
 
@@ -101,15 +103,42 @@ module Danger
 
       return [] unless approval_rules
 
-      approval_rules.filter_map do |rule|
-        rule["rule_type"] == "code_owner" &&
-          rule["approvals_required"] > 0 &&
+      required_approval_rules = unique_approval_rules(approval_rules)
+      required_approval_rules.filter_map do |rule|
+        spin_for_approval_rule?(rule) &&
           Approval.from_approval_rule(rule, spin_for_approver(rule))
       end
     end
 
     private
 
+    def spin_for_approval_rule?(rule)
+      rule["rule_type"] == "code_owner" &&
+        rule["approvals_required"] > 0 &&
+        # Exclude generic codeowners rule, which should be covered by others already
+        !generic_codeowners_rule?(rule)
+    end
+
+    def generic_codeowners_rule?(rule)
+      rule["section"] == "codeowners" && rule["name"] == "*"
+    end
+
+    # Returns an array containing all unique approval rules, based on on the section and eligible_approvers of the rules
+    #
+    # @param [Array<Hash>] approval rules
+    # @return [Array<Hash>]
+    def unique_approval_rules(approval_rules)
+      approval_rules.uniq do |rule|
+        section = rule["section"]
+
+        approvers = rule["eligible_approvers"].map do |approver|
+          approver["username"]
+        end
+
+        [section, approvers]
+      end
+    end
+
     # @param [Gitlab::Dangerfiles::Teammate] person
     # @return [Boolean]
     def valid_person?(person)
@@ -168,11 +197,8 @@ module Danger
     #
     # @return [Gitlab::Dangerfiles::Teammate]
     def spin_for_approver(rule)
-      # This will filter out approvers who are not even reviewers who
-      # don't show up in roulette data we're relying on.
-      # That's why `filter_map` is used.
       approvers = rule["eligible_approvers"].filter_map do |approver|
-        find_member(approver["username"])
+        find_member(approver["username"], project: config_project_name.downcase)
       end
 
       spin_for_person(approvers) || spin_for_approver_fallback(rule)
@@ -250,8 +276,22 @@ module Danger
         end
     end
 
-    def find_member(username)
-      company_members.find { |person| person.username == username }
+    def find_member(username, project: nil)
+      company_members.find do |member|
+        member.username == username &&
+          if project
+            member.in_project?(project)
+          else
+            true
+          end
+      end
+    end
+
+    # Return the configured project name
+    #
+    # @return [String]
+    def config_project_name
+      helper.config.project_name
     end
 
     # Like +team+, but only returns teammates in the current project, based on
@@ -261,7 +301,7 @@ module Danger
     def project_team(project_name)
       company_members.select do |member|
         member.in_project?(project_name) ||
-          member.in_project?("gitlab") # Used for backup reviewer
+          member.in_project?("gitlab") # Used for universal reviewer
       end
     rescue => err
       warn("Reviewer roulette failed to load team data: #{err.message}")

data/lib/danger/rules/commit_messages/Dangerfile

@@ -54,7 +54,7 @@ def lint_commit(commit)
   return linter if linter.fixup? && helper.squash_mr?
 
   if linter.fixup?
-    msg = "Squash or fixup commits must be squashed before merge, or enable squash merge option and re-run #{danger_job_link}."
+    msg = "Squash or fixup commits must be squashed before merge, or **edit** the merge request, enable **Squash commits when merge request is accepted** and re-run #{danger_job_link}."
     if helper.draft_mr? || helper.squash_mr?
       warn_commit(commit, msg, more_info: false)
     else
@@ -68,7 +68,7 @@ def lint_commit(commit)
   # Fail if a suggestion commit is used and squash is not enabled
   if linter.suggestion?
     unless helper.squash_mr?
-      fail_commit(commit, "If you are applying suggestions, enable squash in the merge request and re-run #{danger_job_link}.", more_info: false)
+      fail_commit(commit, "If you are applying suggestions, **edit** the merge request, enable **Squash commits when merge request is accepted** and re-run #{danger_job_link}.", more_info: false)
     end
 
     return linter

data/lib/danger/rules/subtype_label/Dangerfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+SUBTYPE_LABEL_MISSING_MESSAGE = "Please add a [merge request subtype](https://about.gitlab.com/handbook/engineering/metrics/#work-type-classification) to this merge request."
+
+types = %w(bug feature maintenance)
+types.each do |type|
+  return if helper.has_scoped_label_with_scope?(type)
+end
+
+if ENV['DANGER_ERROR_WHEN_SUBTYPE_LABEL_IS_MISSING'] == 'true'
+  fail SUBTYPE_LABEL_MISSING_MESSAGE
+else
+  warn SUBTYPE_LABEL_MISSING_MESSAGE
+end

data/lib/danger/rules/type_label/Dangerfile

@@ -4,14 +4,14 @@ TYPE_LABEL_MISSING_MESSAGE = "Please add a [merge request type](https://about.gi
 
 require_relative "../../../gitlab/dangerfiles/type_label_guesser"
 
-if respond_to?(:changelog) && !helper.has_scoped_label_with_scope?("type")
+return if helper.has_scoped_label_with_scope?("type")
+
+if respond_to?(:changelog)
   type_label_guesser = Gitlab::Dangerfiles::TypeLabelGuesser.new
   helper.labels_to_add.concat(type_label_guesser.labels_from_changelog_categories(changelog.categories))
 end
 
-return if helper.has_scoped_label_with_scope?("type")
-
-if ENV["DANGER_ERROR_WHEN_TYPE_LABEL_IS_MISSING"]
+if ENV['DANGER_ERROR_WHEN_TYPE_LABEL_IS_MISSING'] == 'true'
   fail TYPE_LABEL_MISSING_MESSAGE
 else
   warn TYPE_LABEL_MISSING_MESSAGE

data/lib/gitlab/dangerfiles/teammate.rb

@@ -130,7 +130,7 @@ module Gitlab
           area && labels.any?("devops::#{area.downcase}") if kind == :reviewer
         when :tooling, :engineering_productivity # Deprecated as of 2.3.0 in favor of tooling
           return true if capabilities(project).include?("#{kind} #{category}")
-          return false if kind == :maintainer
+          return false if %i[trainee_maintainer maintainer].include?(kind)
 
           capabilities(project).include?("#{kind} backend") # fallback to backend reviewer
         when :integrations_be
@@ -143,10 +143,10 @@ module Gitlab
           capabilities(project).include?("#{kind}")
         else
           capabilities(project).include?("#{kind} #{category}")
-        end || has_backup_capability?(category, kind, labels)
+        end || has_universal_capability?(category, kind, labels)
       end
 
-      def has_backup_capability?(category, kind, labels)
+      def has_universal_capability?(category, kind, labels)
         case category
         when :ux
           capacity = "#{kind} #{category}"

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "3.4.3"
+    VERSION = "3.5.2"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 3.4.3
+  version: 3.5.2
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-07-07 00:00:00.000000000 Z
+date: 2022-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -148,6 +148,7 @@ files:
 - ".gitlab/CODEOWNERS"
 - ".gitlab/changelog_config.yml"
 - ".gitlab/merge_request_templates/Release.md"
+- ".gitpod.yml"
 - ".rspec"
 - ".yardopts"
 - CODE_OF_CONDUCT.md
@@ -172,6 +173,7 @@ files:
 - lib/danger/rules/commit_messages/Dangerfile
 - lib/danger/rules/commits_counter/Dangerfile
 - lib/danger/rules/simple_roulette/Dangerfile
+- lib/danger/rules/subtype_label/Dangerfile
 - lib/danger/rules/type_label/Dangerfile
 - lib/danger/rules/z_add_labels/Dangerfile
 - lib/danger/rules/z_retry_link/Dangerfile