gitlab-dangerfiles 2.9.3 → 2.10.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 51f1b9ce0d37840b9810a3bc19cdf3c6e35ed8d14f7cf0495a52e1410468b34e
-  data.tar.gz: 763783874f9e0e72b33408f2718d6151a7530526ab3498529ea40d2c02fa4f25
+  metadata.gz: ce597e38c3466f9c039d8b7938c2eb3e8fcf01142608211636f6106310c793ec
+  data.tar.gz: f8d79cb8a4019d70cb0cb206386b219ae4e37074694f26f39f35f8e8a93523ac
 SHA512:
-  metadata.gz: b204d42cc13b8b06801f4da675617e63b56fba631b4122ed4140e0188ea5143d5ec07732b41c6581426d4a5e9e48939f2e260b9f3636afcaac1a96f2aaf78e29
-  data.tar.gz: 6bc734af3d2148cbfb67e23e2cef84f7b36ffb7b82f82b8b9d9d2ca410f95a72d5f72b68dc4d0e59d4f8811df61a536e3282793a6c22f37058e1038e0bc0b6db
+  metadata.gz: 00b61a080b6872088e2ded726bd0c4af98935c07177fabeaa082c2f09bfc8542cf8d0c69ed01d7384d71726062ede02642cf7e52a19c46f6e8b6c7e4e7eb79b3
+  data.tar.gz: 32acb334ddc1b186b91efd0d550bc303613d37bfea89a7ae38ea3ab3f29937b72b9b81e88ed2f7a80c96181cc6ec110c836a9368667695073b2e77b2268ee5af

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2020-2021 GitLab
+Copyright (c) 2020-present GitLab
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -131,7 +131,17 @@ 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 ensures the merge request has a proper [type label](https://about.gitlab.com/handbook/engineering/metrics/#work-type-classification) set.
+
+If the `changelog` plugin is available, it also tries to infer a type label from the `Changelog` trailer of the MR.
+
+#### `z_add_labels`
+
+This rule adds labels set from other rules (via `helper.labels_to_add`), with a single API request.
+
+#### `z_retry_link`
+
+This rule adds a retry link to the job where Danger ran at the end of the Danger message, only if there's any other message to post.
 
 ### CI configuration
 

data/lib/danger/plugins/changelog.rb

@@ -40,14 +40,17 @@ module Danger
         This merge request requires a changelog entry because it [%<reason>s](https://docs.gitlab.com/ee/development/changelog.html#what-warrants-a-changelog-entry).
       MSG
     }.freeze
-
-    def self.categories
-      @categories ||= YAML
-        .load_file("#{ENV["CI_PROJECT_DIR"]}/.gitlab/changelog_config.yml")
-        .fetch("categories")
-        .keys
-        .freeze rescue []
-    end
+    CHANGELOG_CONFIG_FILE = "#{ENV["CI_PROJECT_DIR"]}/.gitlab/changelog_config.yml"
+    DEFAULT_CHANGELOG_CATEGORIES = %w[
+      added
+      fixed
+      changed
+      deprecated
+      removed
+      security
+      performance
+      other
+    ].freeze
 
     class ChangelogCheckResult
       attr_reader :errors, :warnings, :markdowns, :messages
@@ -90,6 +93,24 @@ module Danger
       end
     end
 
+    class CommitWrapper
+      extend Forwardable
+
+      attr_reader :category, :trailer_key
+
+      def initialize(commit, trailer_key, category)
+        @commit = commit
+        @trailer_key = trailer_key
+        @category = category
+      end
+
+      delegate %i[message sha] => :@commit
+    end
+
+    def categories
+      valid_changelog_commits.map(&:category)
+    end
+
     # rubocop:disable Style/SignalException
     def check!
       if git.modified_files.include?("CHANGELOG.md")
@@ -126,17 +147,13 @@ module Danger
     end
 
     def check_changelog_trailer(commit)
-      trailer = commit.message.match(CHANGELOG_TRAILER_REGEX)
-      name = trailer[:name]
-      category = trailer[:category]
-
-      unless name == "Changelog"
-        return ChangelogCheckResult.error("The changelog trailer for commit #{commit.sha} must be `Changelog` (starting with a capital C), not `#{name}`")
+      unless commit.trailer_key == "Changelog"
+        return ChangelogCheckResult.error("The changelog trailer for commit #{commit.sha} must be `Changelog` (starting with a capital C), not `#{commit.trailer_key}`")
       end
 
-      return ChangelogCheckResult.empty if self.class.categories.include?(category)
+      return ChangelogCheckResult.empty if valid_categories.include?(commit.category)
 
-      ChangelogCheckResult.error("Commit #{commit.sha} uses an invalid changelog category: #{category}")
+      ChangelogCheckResult.error("Commit #{commit.sha} uses an invalid changelog category: #{commit.category}")
     end
 
     def check_changelog_path
@@ -180,16 +197,16 @@ module Danger
     end
 
     def changelog_commits
-      git.commits.select do |commit|
-        commit.message.match?(CHANGELOG_TRAILER_REGEX)
+      git.commits.each_with_object([]) do |commit, memo|
+        trailer = commit.message.match(CHANGELOG_TRAILER_REGEX)
+
+        memo << CommitWrapper.new(commit, trailer[:name], trailer[:category]) if trailer
       end
     end
 
     def valid_changelog_commits
       changelog_commits.select do |commit|
-        trailer = commit.message.match(CHANGELOG_TRAILER_REGEX)
-
-        self.class.categories.include?(trailer[:category])
+        valid_categories.include?(commit.message.match(CHANGELOG_TRAILER_REGEX)[:category])
       end
     end
 
@@ -219,6 +236,28 @@ module Danger
 
     private
 
+    def valid_categories
+      return @categories if defined?(@categories)
+
+      @categories = if File.exist?(CHANGELOG_CONFIG_FILE)
+          begin
+            YAML
+              .load_file(CHANGELOG_CONFIG_FILE)
+              .fetch("categories")
+              .keys
+              .freeze
+          rescue Psych::SyntaxError, Psych::DisallowedClass => ex
+            puts "#{CHANGELOG_CONFIG_FILE} doesn't seem to be a valid YAML file:\n#{ex.message}\nFallbacking to the default categories: #{DEFAULT_CHANGELOG_CATEGORIES}"
+            DEFAULT_CHANGELOG_CATEGORIES
+          rescue => ex
+            puts "Received an unexpected failure while trying to fetch categories at #{CHANGELOG_CONFIG_FILE}:\n#{ex.message}\nFallbacking to the default categories: #{DEFAULT_CHANGELOG_CATEGORIES}"
+            DEFAULT_CHANGELOG_CATEGORIES
+          end
+        else
+          DEFAULT_CHANGELOG_CATEGORIES
+        end
+    end
+
     def read_file(path)
       File.read(path)
     end

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

@@ -120,7 +120,7 @@ module Danger
     #   +modified_files+ might contain paths that already have been renamed,
     #   so we need to remove them from the list.
     def all_changed_files
-      changes.files - changes.renamed_before.files
+      changes.files - changes.deleted.files - changes.renamed_before.files
     end
 
     # @param filename [String] A file name for which we want the diff.
@@ -282,7 +282,7 @@ module Danger
     def mr_labels
       return [] unless ci?
 
-      (gitlab_helper.mr_labels + labels_to_add.to_a).uniq
+      (gitlab_helper.mr_labels + labels_to_add).uniq
     end
 
     # @return [String] +`git rev-parse --abbrev-ref HEAD`+ when not in the CI context, and the MR source branch otherwise.
@@ -409,9 +409,9 @@ module Danger
     # itself. Without this method, the first rule wouldn't know that the label would be applied and would ask
     # for it anyway.
     #
-    # @return [Set<String>] the list of labels that Danger will add
+    # @return [Array<String>] the list of labels that Danger will add
     def labels_to_add
-      @labels_to_add ||= Set.new
+      @labels_to_add ||= []
     end
 
     private

data/lib/danger/rules/type_label/Dangerfile

@@ -1,5 +1,12 @@
 # frozen_string_literal: true
 
+require_relative "../../../gitlab/dangerfiles/type_label_guesser"
+
+if respond_to?(:changelog) && !helper.has_scoped_label_with_scope?("type")
+  type_label_guesser = Gitlab::Dangerfiles::TypeLabelGuesser.new
+  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."
 end

data/lib/danger/rules/z_add_labels/Dangerfile

@@ -1,4 +1,4 @@
-# This rule is the last one since we want to add all the labels to add at once,
+# This rule is the (almost) last one since we want to add all the labels to add at once,
 # so we let other rules adding to `helper.labels_to_add` before actually adding them via the API here.
 
 # Don't try to post anything locally.
@@ -13,9 +13,3 @@ rescue Gitlab::Error::Forbidden
 end
 
 post_labels(helper.labels_to_add) if helper.labels_to_add.any?
-
-anything_to_post = status_report.values.any?(&:any?)
-
-if anything_to_post
-  markdown("**If needed, you can retry the [`danger-review` job](#{ENV["CI_JOB_URL"]}) that generated this comment.**")
-end

data/lib/danger/rules/z_retry_link/Dangerfile

@@ -0,0 +1,10 @@
+# This rule is the last one since we only want to post the "retry" message if there are anything to be posted.
+
+# There's no job to retry locally.
+return unless helper.ci?
+
+anything_to_post = status_report.values.any?(&:any?)
+
+if anything_to_post
+  markdown("**If needed, you can retry the [🔁 `danger-review` job](#{ENV['CI_JOB_URL']}) that generated this comment.**")
+end

data/lib/gitlab/dangerfiles/type_label_guesser.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module Dangerfiles
+    class TypeLabelGuesser
+      CHANGELOG_CATEGORY_TO_TYPE_LABEL = {
+        fixed: %w[type::bug],
+        security: %w[type::bug bug::vulnerability],
+        performance: %w[type::bug bug::performance],
+        added: %w[type::feature feature::addition],
+        deprecated: %w[type::feature feature::removal],
+        removed: %w[type::feature feature::removal],
+      }.freeze
+
+      def labels_from_changelog_categories(categories)
+        categories = categories.map(&:to_sym) & CHANGELOG_CATEGORY_TO_TYPE_LABEL.keys
+        return [] unless categories.one?
+
+        CHANGELOG_CATEGORY_TO_TYPE_LABEL.fetch(categories.first.to_sym, [])
+      end
+    end
+  end
+end

data/lib/gitlab/dangerfiles/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module Dangerfiles
-    VERSION = "2.9.3"
+    VERSION = "2.10.2"
   end
 end

data/lib/gitlab/dangerfiles.rb

@@ -17,6 +17,7 @@ module Gitlab
       simple_roulette
       type_label
       z_add_labels
+      z_retry_link
     ].freeze
 
     # Utility method to construct a [Gitlab::Dangerfiles::Engine] instance,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-dangerfiles
 version: !ruby/object:Gem::Version
-  version: 2.9.3
+  version: 2.10.2
 platform: ruby
 authors:
 - GitLab
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-03-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-gitlab
@@ -158,6 +158,7 @@ files:
 - lib/danger/rules/simple_roulette/Dangerfile
 - lib/danger/rules/type_label/Dangerfile
 - lib/danger/rules/z_add_labels/Dangerfile
+- lib/danger/rules/z_retry_link/Dangerfile
 - lib/gitlab-dangerfiles.rb
 - lib/gitlab/Dangerfile
 - lib/gitlab/dangerfiles.rb
@@ -170,6 +171,7 @@ files:
 - lib/gitlab/dangerfiles/spec_helper.rb
 - lib/gitlab/dangerfiles/teammate.rb
 - lib/gitlab/dangerfiles/title_linting.rb
+- lib/gitlab/dangerfiles/type_label_guesser.rb
 - lib/gitlab/dangerfiles/version.rb
 - lib/gitlab/dangerfiles/weightage.rb
 - lib/gitlab/dangerfiles/weightage/maintainers.rb