create_github_release 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 992d339f1f9a903ed6ad37567e05e66008d3a47c5af83f34c9b14e68cfb64b53
-  data.tar.gz: 5549566d6d953cff76fd554b8e90fb5b3229f939127d8d7b887bd1c39878d8b4
+  metadata.gz: 312da511d779225d398925e66001d292366c70883f24c739b0e6288e0082891f
+  data.tar.gz: d5dc70f33050b9b1cbd0d8d228782c294bca9c73143e0b4724869224c802f59d
 SHA512:
-  metadata.gz: a3ef1922049a7f3901f5d8ab88475ec33e49e290cc3a29ac3744bf40a2e9cc5850ce35eb3ca386642c0936270b5815018d5ad56fe874257aebe97991fd859147
-  data.tar.gz: 711efa3fb69ddd9d4b746752ec5a5229ec30717d17b93b81b4be9af95cc2560dfa82615452044621ddfa9799d986abaa630abf04f1e6fc0387016118b4d5acc9
+  metadata.gz: e3bd21e337933bb66b61f8eda03f7b9e932b547427161a2970d61d6d7f6009a395dc5db64cf3ac56b44480bac4bc5b6c9903b2702fc606803533373b6691db3c
+  data.tar.gz: 6302667c91366596ca30aacfa2114e7c62bbfbfdaa5ff5f6c0b7b05af4e52da82e4e4dd9d43d17172474ea5146bdfeadb6c6b45c8fbc24564e0d5763a6c7a6b5

data/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## v1.5.0 (2024-09-10)
+
+[Full Changelog](https://github.com/main-branch/create_github_release/compare/v1.4.0..v1.5.0)
+
+Changes since v1.4.0:
+
+* fdc35ee Optionally apply a release label to release PRs
+* c122e7f Add Semver PR Label Check workflow
+* afc3883 Update to the latest version of the CodeClimate test coverage reporter
+* 0a57cbd Fix test errors due to array being in different order
+* 30d46fb Fix rubocop offense from new Gemspec/AddRuntimeDependency cop
+
 ## v1.4.0 (2024-05-10)
 
 [Full Changelog](https://jcouball@github.com/main-branch/create_github_release/compare/v1.3.4..v1.4.0)

data/create_github_release.gemspec

@@ -35,7 +35,7 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'version_boss', '~> 0.1'
+  spec.add_dependency 'version_boss', '~> 0.1'
 
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
   spec.add_development_dependency 'debug', '~> 1.9'

data/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

data/lib/create_github_release/assertions.rb

@@ -21,5 +21,6 @@ require_relative 'assertions/local_release_tag_does_not_exist'
 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'

data/lib/create_github_release/command_line/options.rb

@@ -63,6 +63,13 @@ module CreateGithubRelease
       #   @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')

data/lib/create_github_release/command_line/parser.rb

@@ -140,10 +140,20 @@ module CreateGithubRelease
         %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

data/lib/create_github_release/command_line.rb

@@ -32,7 +32,7 @@ module CreateGithubRelease
     # @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

data/lib/create_github_release/project.rb

@@ -69,7 +69,8 @@ module CreateGithubRelease
       :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 @@ module CreateGithubRelease
       @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

data/lib/create_github_release/release_assertions.rb

@@ -61,7 +61,8 @@ module CreateGithubRelease
       CreateGithubRelease::Assertions::LocalReleaseBranchDoesNotExist,
       CreateGithubRelease::Assertions::RemoteReleaseBranchDoesNotExist,
       CreateGithubRelease::Assertions::GhCommandExists,
-      CreateGithubRelease::Assertions::GhAuthenticated
+      CreateGithubRelease::Assertions::GhAuthenticated,
+      CreateGithubRelease::Assertions::ReleasePrLabelExists
     ].freeze
 
     # Run all assertions

data/lib/create_github_release/tasks/create_release_pull_request.rb

@@ -48,7 +48,7 @@ module CreateGithubRelease
         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
@@ -56,6 +56,23 @@ module CreateGithubRelease
         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

data/lib/create_github_release/version.rb

@@ -2,5 +2,5 @@
 
 module CreateGithubRelease
   # The version of this gem
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: create_github_release
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - James
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-10 00:00:00.000000000 Z
+date: 2024-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: version_boss
@@ -219,6 +219,7 @@ files:
 - lib/create_github_release/assertions/no_staged_changes.rb
 - lib/create_github_release/assertions/no_uncommitted_changes.rb
 - lib/create_github_release/assertions/on_default_branch.rb
+- lib/create_github_release/assertions/release_pr_label_exists.rb
 - lib/create_github_release/assertions/remote_release_branch_does_not_exist.rb
 - lib/create_github_release/assertions/remote_release_tag_does_not_exist.rb
 - lib/create_github_release/backtick_debug.rb
@@ -250,8 +251,8 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/main-branch/create_github_release
   source_code_uri: https://github.com/main-branch/create_github_release
-  changelog_uri: https://rubydoc.info/gems/create_github_release/1.4.0/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/create_github_release/1.4.0
+  changelog_uri: https://rubydoc.info/gems/create_github_release/1.5.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/create_github_release/1.5.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -268,7 +269,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: A script to create a GitHub release for a Ruby Gem