gitlab-dangerfiles 3.4.1 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17495e36a06253d291cf69ea61fd426ba3541738591873cfdef64e2c9132e8ee
-  data.tar.gz: 5e690f454e356ae1dd7e372ae16d9d8b99b32e1450a48560fe359dfcad20eab9
+  metadata.gz: d29ef356c65c4a2ceec87eccbe6d723ee26ae1175176b788d13c146b508ec9fb
+  data.tar.gz: fd15845d7c87873c15a8f144fa1bbca3801f0f45dc8e7363585110df07cbb11e
 SHA512:
-  metadata.gz: f96558f5954dea10cf802d32003045dcdcb6bccaa00c34b4079a654a275ec8dcb980ca84bf8116d87db1e0dc8a5e85a54b07ec05dc2dbcab4b2696e3e1532173
-  data.tar.gz: b112119bfbbff88bb66966bed0e5ee0cd32369b2eae89507e17f9e602a8c0a987bbd423aa1a4ed089479c1d9f6842f523db76e83c887676c9387cbd6da4db3e3
+  metadata.gz: e14eb3849ed8da68ac7a716347ff89b4a2df7fbd47b014663807c913632fa6f6d363de94b94aa2df868335e6e5d5af0362f477c07b5d3519b5bd46219623150f
+  data.tar.gz: 6f233f7f4b679dcca8ab438f54fd0ff4a400e8527614d675562421b818ad1dfe505874259cfc7e718dbba665c6dde02551520168b71630b39ad2680949db2b1c

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

@@ -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,7 +103,8 @@ module Danger
 
       return [] unless approval_rules
 
-      approval_rules.filter_map do |rule|
+      required_approval_rules = unique_approval_rules(approval_rules)
+      required_approval_rules.filter_map do |rule|
         rule["rule_type"] == "code_owner" &&
           rule["approvals_required"] > 0 &&
           Approval.from_approval_rule(rule, spin_for_approver(rule))
@@ -110,6 +113,22 @@ module Danger
 
     private
 
+    # 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)
@@ -226,6 +245,10 @@ module Danger
     def http_get_json(url)
       rsp = Net::HTTP.get_response(URI.parse(url))
 
+      if rsp.is_a?(Net::HTTPRedirection)
+        raise "Redirection detected: #{rsp.header["location"]}"
+      end
+
       unless rsp.is_a?(Net::HTTPOK)
         raise HTTPError, "Failed to read #{url}: #{rsp.code} #{rsp.message}"
       end
@@ -257,7 +280,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/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/changes.rb

@@ -62,7 +62,7 @@ module Gitlab
 
       # @return [Array<String>] an array of the changed files.
       def files
-        map(&:file)
+        map(&:file).uniq
       end
 
       private

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.1"
+    VERSION = "3.5.0"
   end
 end

data/lib/gitlab/dangerfiles.rb

@@ -58,7 +58,7 @@ module Gitlab
         danger_plugin.import_plugin(File.expand_path("../danger/plugins/*.rb", __dir__))
 
         Dir.glob(File.expand_path("danger/plugins/*.rb", config.project_root)).sort.each do |path|
-          puts "Importing plugin at #{path}" if dangerfile.verbose
+          puts "Importing plugin at #{path}" if helper_plugin.ci?
           danger_plugin.import_plugin(path)
         end
       end
@@ -87,10 +87,9 @@ module Gitlab
         return if helper_plugin.release_automation?
 
         rules = filtered_rules(only, except)
-        puts "Running rules: #{rules}\n" if dangerfile.verbose
 
         rules.each do |rule, path|
-          puts "Importing rule #{rule} at #{path}" if dangerfile.verbose
+          puts "Importing rule #{rule} at #{path}" if helper_plugin.ci?
           danger_plugin.import_dangerfile(path: path)
         end
       end
@@ -116,45 +115,45 @@ module Gitlab
 
       attr_reader :dangerfile
 
+      def filtered_rules(only_rules, except_rules)
+        only_rules = Array(only_rules).compact.map(&:to_s)
+
+        rules = allowed_rules_based_on_context.reject { |rule, _v| except_rules.include?(rule) }
+
+        if only_rules.any?
+          rules.select! { |rule, _v| only_rules.include?(rule) }
+        end
+
+        rules.sort.to_h
+      end
+
+      def allowed_rules_based_on_context
+        helper_plugin.ci? ? all_rules : local_rules
+      end
+
+      def all_rules
+        all_gem_rules.merge(custom_rules)
+      end
+
       def all_gem_rules
-        @all_gem_rules ||= Dir.glob(File.join(RULES_DIR, "*")).sort.each_with_object({}) do |path, memo|
+        @all_gem_rules ||= Dir.glob(File.join(RULES_DIR, "*")).each_with_object({}) do |path, memo|
           rule_name = File.basename(path)
           memo[rule_name] = path if File.directory?(path) && File.exist?(File.join(path, "Dangerfile"))
         end
       end
 
       def custom_rules
-        @custom_rules ||= Dir.glob(File.expand_path("danger/*", config.project_root)).sort.each_with_object({}) do |path, memo|
+        @custom_rules ||= Dir.glob(File.expand_path("danger/*", config.project_root)).each_with_object({}) do |path, memo|
           rule_name = File.basename(path)
           memo[rule_name] = path if File.directory?(path) && File.exist?(File.join(path, "Dangerfile"))
         end
       end
 
-      def all_rules
-        all_gem_rules.merge(custom_rules)
-      end
-
       def local_rules
         ci_only_rules = CI_ONLY_RULES | config.ci_only_rules
         all_rules.reject { |rule, _v| ci_only_rules.include?(rule) }
       end
 
-      def allowed_rules_based_on_context
-        helper_plugin.ci? ? all_rules : local_rules
-      end
-
-      def filtered_rules(only_rules, except_rules)
-        only_rules = Array(only_rules).compact.map(&:to_s)
-
-        rules = allowed_rules_based_on_context.reject { |rule, _v| except_rules.include?(rule) }
-
-        if only_rules.any?
-          rules.select! { |rule, _v| only_rules.include?(rule) }
-        end
-
-        rules
-      end
-
       def danger_plugin
         @danger_plugin ||= dangerfile.plugins[Danger::DangerfileDangerPlugin]
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 3.4.1
+  version: 3.5.0
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-06-22 00:00:00.000000000 Z
+date: 2022-07-25 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