Optionally apply a release label to release PRs

Author: jcouball

lib/create_github_release/assertions.rb

@@ -21,5 +21,6 @@ module Assertions; end
 require_relative 'assertions/no_staged_changes'
 require_relative 'assertions/no_uncommitted_changes'
 require_relative 'assertions/on_default_branch'
+require_relative 'assertions/release_pr_label_exists'
 require_relative 'assertions/remote_release_branch_does_not_exist'
 require_relative 'assertions/remote_release_tag_does_not_exist'

lib/create_github_release/assertions/release_pr_label_exists.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'create_github_release/assertion_base'
+
+module CreateGithubRelease
+  module Assertions
+    # Assert that the release tag does not exist in the local repository
+    #
+    # @api public
+    #
+    class ReleasePrLabelExists < AssertionBase
+      # Assert that the release pr label is defined in GitHub
+      #
+      # @example
+      #   require 'create_github_release'
+      #
+      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major', o.release_pr_label = 'release' }
+      #   assertion = CreateGithubRelease::Assertions::LastReleaseTagExists.new(options)
+      #   begin
+      #     assertion.assert
+      #     puts 'Assertion passed'
+      #   rescue SystemExit
+      #     puts 'Assertion failed'
+      #   end
+      #
+      # @return [void]
+      #
+      # @raise [SystemExit] if the assertion fails
+      #
+      def assert
+        return if project.release_pr_label.nil?
+
+        print "Checking that release pr label '#{project.release_pr_label}' exists..."
+
+        if labels.include?(project.release_pr_label)
+          puts 'OK'
+        else
+          error "Release pr label '#{project.release_pr_label}' does not exist"
+        end
+      end
+
+      private
+
+      # Get the list of labels for the current repository from GitHub
+      # @return [Array<String>] The list of labels for the current repository
+      # @api private
+      def labels
+        output = `gh label list`
+        error 'Could not list pr labels' unless $CHILD_STATUS.success?
+
+        output.lines.map(&:chomp).map { |line| line.split("\t").first }
+      end
+    end
+  end
+end

lib/create_github_release/command_line.rb

@@ -32,7 +32,7 @@ module CommandLine
     # @return [Array<Symbol>]
     ALLOWED_OPTIONS = %i[
       release_type pre pre_type default_branch release_branch remote last_release_version
-      next_release_version changelog_path quiet verbose
+      next_release_version release_pr_label changelog_path quiet verbose
     ].freeze
   end
 end

lib/create_github_release/command_line/options.rb

@@ -63,6 +63,13 @@ class Options
       #   @return [String]
       #   @api public
 
+      # @!attribute release_pr_label [rw] the label to apply to the release pull request
+      #   @example
+      #     options = CreateGithubRelease::CommandLine::Options.new(release_pr_label: 'release')
+      #     options.release_pr_label #=> 'release'
+      #   @return [String]
+      #   @api public
+
       # @attribute changelog_path [rw] the path to the changelog file
       #   @example
       #     options = CreateGithubRelease::CommandLine::Options.new(changelog_path: 'CHANGELOG.md')

lib/create_github_release/command_line/parser.rb

@@ -140,10 +140,20 @@ def define_options
         %i[
           define_help_option define_default_branch_option define_release_branch_option define_pre_option
           define_pre_type_option define_remote_option define_last_release_version_option define_version_option
-          define_next_release_version_option define_changelog_path_option define_quiet_option define_verbose_option
+          define_next_release_version_option define_release_pr_label_option define_changelog_path_option
+          define_quiet_option define_verbose_option
         ].each { |m| send(m) }
       end
 
+      # Define the release_pr_label option which requires a value
+      # @return [void]
+      # @api private
+      def define_release_pr_label_option
+        option_parser.on('--release-pr-label=LABEL', 'The label to apply to the release pull request') do |label|
+          options.release_pr_label = label
+        end
+      end
+
       # Define the pre option
       # @return [void]
       # @api private

lib/create_github_release/project.rb

@@ -69,7 +69,8 @@ def initialize(options)
       :release_type, :pre, :pre_type, :release_url, :remote, :remote_base_url,
       :remote_repository, :remote_url, :changelog_path, :changes,
       :next_release_description, :last_release_changelog, :next_release_changelog,
-      :first_commit, :verbose, :quiet, :release_pr_number, :release_pr_url
+      :first_commit, :verbose, :quiet, :release_pr_number, :release_pr_url,
+      :release_pr_label
 
     # attr_writer :first_release
 
@@ -292,6 +293,34 @@ def release_branch
       @release_branch ||= options.release_branch || "release-#{next_release_tag}"
     end
 
+    # @!attribute [rw] release_pr_label
+    #
+    # The name of the label to apply to the release pull request
+    #
+    # @example By default, `release_pr_label` is nil indicating no label should be applied
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
+    #   project = CreateGithubRelease::Project.new(options)
+    #   project.release_pr_label #=> nil
+    #
+    # @example Set to 'release'
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major', release_pr_label: 'release')
+    #   project = CreateGithubRelease::Project.new(options)
+    #   project.release_pr_label #=> 'release'
+    #
+    # @example It can also be set explicitly
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
+    #   project = CreateGithubRelease::Project.new(options)
+    #   project.release_pr_label = 'release' # could be set to nil to remove the label
+    #   project.release_pr_label #=> 'release'
+    #
+    # @return [String, nil]
+    #
+    # @api public
+    #
+    def release_pr_label
+      @release_pr_label ||= options.release_pr_label || nil
+    end
+
     # @!attribute [rw] release_log_url
     #
     # The URL of the page containing a list of the changes in the release

lib/create_github_release/release_assertions.rb

@@ -61,7 +61,8 @@ def initialize(options)
       CreateGithubRelease::Assertions::LocalReleaseBranchDoesNotExist,
       CreateGithubRelease::Assertions::RemoteReleaseBranchDoesNotExist,
       CreateGithubRelease::Assertions::GhCommandExists,
-      CreateGithubRelease::Assertions::GhAuthenticated
+      CreateGithubRelease::Assertions::GhAuthenticated,
+      CreateGithubRelease::Assertions::ReleasePrLabelExists
     ].freeze
 
     # Run all assertions

lib/create_github_release/tasks/create_release_pull_request.rb

@@ -48,14 +48,31 @@ def create_release_pr(path)
         print 'Creating GitHub pull request...'
         tag = project.next_release_tag
         default_branch = project.default_branch
-        `gh pr create --title 'Release #{tag}' --body-file '#{path}' --base '#{default_branch}'`
+        `#{command(tag, path, default_branch)}`
         if $CHILD_STATUS.success?
           puts 'OK'
         else
           error 'Could not create release pull request'
         end
       end
 
+      # The command to create the release pull request
+      # @param tag [String] The tag for the release
+      # @param path [String] The path to the file with the PR body
+      # @param default_branch [String] The default branch for the repository
+      # @return [String] The command to create the release pull request
+      # @api private
+      def command(tag, path, default_branch)
+        command = [
+          'gh', 'pr', 'create',
+          '--title', "'Release #{tag}'",
+          '--body-file', "'#{path}'",
+          '--base', "'#{default_branch}'"
+        ]
+        command += ['--label', "'#{project.release_pr_label}'"] if project.release_pr_label
+        command.join(' ')
+      end
+
       # Write the changelog to a new temporary file
       # @return [String] the path to the temporary file
       # @raise [SystemExit] if the temp could not be created

spec/create_github_release/assertions/release_pr_label_exists_spec.rb

@@ -0,0 +1,129 @@
+# frozen_string_literal: true
+
+RSpec.describe CreateGithubRelease::Assertions::ReleasePrLabelExists do
+  let(:assertion) { described_class.new(project) }
+  let(:options) { CreateGithubRelease::CommandLine::Options.new { |o| o.release_type = 'major' } }
+  let(:project) { CreateGithubRelease::Project.new(options) { |p| p.release_pr_label = release_pr_label } }
+  let(:release_pr_label) { nil }
+
+  before do
+    allow(assertion).to receive(:`).with(String) { |command| execute_mocked_command(mocked_commands, command) }
+  end
+
+  describe '#assert' do
+    subject do
+      @stdout, @stderr, exception = capture_output { assertion.assert }
+      raise exception if exception
+    end
+    let(:stdout) { @stdout }
+    let(:stderr) { @stderr }
+
+    context 'when release pr label is nil' do
+      let(:mocked_commands) { [] }
+      it 'should not raise an error' do
+        expect { assertion.assert }.not_to raise_error
+      end
+    end
+
+    context 'when release pr label is "release"' do
+      let(:release_pr_label) { 'release' }
+
+      context 'when the label exists' do
+        let(:mocked_commands) do
+          [
+            MockedCommand.new('gh label list', stdout: <<~LABELS)
+              bug\tSomething isn't working\t#d73a4a
+              release\tThe PR represents a release\t#0075ca
+              duplicate\tThis issue or pull request already exists\t#cfd3d7
+            LABELS
+          ]
+        end
+
+        it 'should not raise an error' do
+          expect { assertion.assert }.not_to raise_error
+        end
+      end
+
+      context 'when the label does not exist' do
+        let(:mocked_commands) do
+          [
+            MockedCommand.new('gh label list', stdout: <<~LABELS)
+              bug\tSomething isn't working\t#d73a4a
+              duplicate\tThis issue or pull request already exists\t#cfd3d7
+            LABELS
+          ]
+        end
+
+        it 'should fail' do
+          expect { subject }.to raise_error(SystemExit)
+          expect(stderr).to start_with("ERROR: Release pr label 'release' does not exist\n")
+        end
+      end
+    end
+
+    context 'when the gh command fails' do
+      let(:release_pr_label) { 'release' }
+
+      let(:mocked_commands) do
+        [
+          MockedCommand.new('gh label list', exitstatus: 1)
+        ]
+      end
+
+      it 'should fail' do
+        expect { subject }.to raise_error(SystemExit)
+        expect(stderr).to start_with('ERROR: Could not list pr labels')
+      end
+    end
+  end
+end
+
+#     context 'when this is the first release' do
+#       let(:release_type) { 'first' }
+#       let(:mocked_commands) { [] }
+#       it 'should not raise an error' do
+#         expect { assertion.assert }.not_to raise_error
+#       end
+#     end
+
+#     context 'when this is NOT the first release' do
+#       context 'when the last release tag does not exist' do
+#         let(:mocked_commands) do
+#           [
+#             MockedCommand.new('git tag --list "v0.0.0"', stdout: "\n")
+#           ]
+#         end
+
+#         it 'should fail' do
+#           expect { subject }.to raise_error(SystemExit)
+#           expect(stderr).to start_with("ERROR: Last release tag 'v0.0.0' does not exist")
+#         end
+#       end
+
+#       context 'when the last release tag exists' do
+#         let(:mocked_commands) do
+#           [
+#             MockedCommand.new('git tag --list "v0.0.0"', stdout: "v0.0.0\n")
+#           ]
+#         end
+
+#         it 'should succeed' do
+#           expect { subject }.not_to raise_error
+#         end
+#       end
+
+#       context 'when the git command fails' do
+#         let(:mocked_commands) do
+#           [
+#             MockedCommand.new('git tag --list "v0.0.0"', exitstatus: 1)
+#           ]
+#         end
+
+#         it 'should fail' do
+#           expect { subject }.to raise_error(SystemExit)
+#           expect(stderr).to start_with('ERROR: Could not list tags')
+#         end
+#       end
+#     end
+#   end
+# end

spec/create_github_release/command_line/parser_spec.rb

@@ -38,6 +38,7 @@
               remote: nil,
               last_release_version: nil,
               next_release_version: nil,
+              release_pr_label: nil,
               changelog_path: nil,
               quiet: false,
               verbose: false
@@ -83,6 +84,7 @@
               remote: nil,
               last_release_version: nil,
               next_release_version: nil,
+              release_pr_label: nil,
               changelog_path: nil,
               quiet: false,
               verbose: false
@@ -128,6 +130,7 @@
               remote: nil,
               last_release_version: nil,
               next_release_version: nil,
+              release_pr_label: nil,
               changelog_path: nil,
               quiet: false,
               verbose: false
@@ -140,6 +143,11 @@
         end
       end
 
+      context 'when the --release-pr-label option is given' do
+        let(:args) { ['patch', '--release-pr-label=release'] }
+        it { is_expected.to have_attributes(release_type: 'patch', release_pr_label: 'release') }
+      end
+
       context 'when the --quiet option is given' do
         let(:args) { ['patch', '--quiet'] }
         it { is_expected.to have_attributes(release_type: 'patch', quiet: true) }