create_github_release 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaae536c7d44e9ced42bb4598ebf91b3e803766c3a9b6283185fee4c7327c3db
-  data.tar.gz: bbbb70f42b368e513d419b2c16490b8ef48d4f6269df342f5d23db6e3088927c
+  metadata.gz: 992d339f1f9a903ed6ad37567e05e66008d3a47c5af83f34c9b14e68cfb64b53
+  data.tar.gz: 5549566d6d953cff76fd554b8e90fb5b3229f939127d8d7b887bd1c39878d8b4
 SHA512:
-  metadata.gz: c3b4a8e4380a61ade20ea5833f7016bed6c5e056b37e78fb2cc6f589fcdce575d0cdd998c1d920507a3b2e6bca16837f99a02724e8d88e01ef9f00e1c9d066ff
-  data.tar.gz: df667078c1f6b9baccb7736a715343c8271dd3054ec42b96fa5bfb1115f955014a3f59f297e2d9cbdd15546dc787383e663c9eb0f756651e8ac812d5d4c35c32
+  metadata.gz: a3ef1922049a7f3901f5d8ab88475ec33e49e290cc3a29ac3744bf40a2e9cc5850ce35eb3ca386642c0936270b5815018d5ad56fe874257aebe97991fd859147
+  data.tar.gz: 711efa3fb69ddd9d4b746752ec5a5229ec30717d17b93b81b4be9af95cc2560dfa82615452044621ddfa9799d986abaa630abf04f1e6fc0387016118b4d5acc9

data/CHANGELOG.md

@@ -5,6 +5,25 @@ 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.4.0 (2024-05-10)
+
+[Full Changelog](https://jcouball@github.com/main-branch/create_github_release/compare/v1.3.4..v1.4.0)
+
+Changes since v1.3.4:
+
+* a2e2500 Increment version with version_boss instead of semverify
+* 44f8d15 Release v1.3.4 (#60)
+
+## v1.3.4 (2024-01-09)
+
+[Full Changelog](https://github.com/main-branch/create_github_release/compare/v1.3.3..v1.3.4)
+
+Changes since v1.3.3:
+
+* 23a5db6 Document the revert-github-release script in the project README (#59)
+* 0ed4549 Format the output so next steps are easier to read (#58)
+* 5442745 Wait for some time between creating the release PR and searching for it (#56)
+
 ## v1.3.3 (2024-01-08)
 
 [Full Changelog](https://github.com/main-branch/create_github_release/compare/v1.3.2..v1.3.3)

data/README.md

@@ -32,8 +32,8 @@ Tested on Ruby 3.0+
     * [Changing the pre-release type](#changing-the-pre-release-type)
     * [Creating the release after pre-releases](#creating-the-release-after-pre-releases)
   * [After Running create-github-release](#after-running-create-github-release)
+  * [Reverting `create-github-release`](#reverting-create-github-release)
 * [FAQ](#faq)
-  * [What if I want to reverse the changes made by this script?](#what-if-i-want-to-reverse-the-changes-made-by-this-script)
   * [How is the changelog updated?](#how-is-the-changelog-updated)
 * [Development](#development)
 * [Contributing](#contributing)
@@ -66,9 +66,9 @@ Options:
     -t, --pre-type=TYPE              Type of pre-release to create (e.g. alpha, beta, etc.)
         --remote=REMOTE_NAME         Use this remote name instead of 'origin'
         --last-release-version=VERSION
-                                     Use this version instead `semverify current`
+                                     Use this version instead `gem-version-boss current`
         --next-release-version=VERSION
-                                     Use this version instead `semverify next-RELEASE_TYPE`
+                                     Use this version instead `gem-version-boss next-RELEASE_TYPE`
         --changelog-path=PATH        Use this file instead of CHANGELOG.md
     -q, --[no-]quiet                 Do not show output
     -v, --[no-]verbose               Show extra output
@@ -90,10 +90,10 @@ If this is to be the first release of this gem follow these instructions.
 For this use case, let's assume the following:
 
 * the default branch is `main` (this is the HEAD branch returned by `git remote show origin`)
-* the current version of the gem is `0.1.0` (as returned by `semverify current`)
+* the current version of the gem is `0.1.0` (as returned by `gem-version-boss current`)
 
 If a different first version number is desired, update the version number in the
-source code making sure that `semverify current` returns the desired version number.
+source code making sure that `gem-version-boss current` returns the desired version number.
 Then commit the change to the default branch on the remote before running this
 script.
 
@@ -131,7 +131,7 @@ create-github-release first
 
 The `create-github-release` script will do the following:
 
-* Determine the next-release version (`v0.1.0`) using `semverify current`
+* Determine the next-release version (`v0.1.0`) using `gem-version-boss current`
 * Update the project's changelog file `CHANGELOG.md`
 * Create a release branch `release-v0.1.0`
 * Commit the changes to the changelog and create a release tag (`v0.1.0`) pointing
@@ -148,7 +148,7 @@ In order to start using `create-github-release` after you have used some other
 method for managing the gem version and creating releases, you need to ensure the
 following prerequisites are met:
 
-1. that `semverify current` is the version of the last release (let's use `1.3.1` as an
+1. that `gem-version-boss current` is the version of the last release (let's use `1.3.1` as an
    example).
 2. that there is a corresponding release tag that points to the last commit on the
    default branch of the previous release. If the last version was `1.3.1`, then
@@ -173,7 +173,7 @@ For this use case, let's assume the following:
 
 * you want to create a `major` release
 * the default branch is `main` (this is the HEAD branch returned by `git remote show origin`)
-* the current version of the gem is `0.1.0` (as returned by `semverify current`)
+* the current version of the gem is `0.1.0` (as returned by `gem-version-boss current`)
 
 The following prerequisites must be met:
 
@@ -196,9 +196,9 @@ create-github-release major
 
 The `create-github-release` script will do the following:
 
-* Determine the last-release version using `semverify current`
-* Determine the next-release version using `semverify RELEASE_TYPE --dry-run`
-* Increment the project's version using `semverify RELEASE_TYPE`
+* Determine the last-release version using `gem-version-boss current`
+* Determine the next-release version using `gem-version-boss RELEASE_TYPE --dry-run`
+* Increment the project's version using `gem-version-boss RELEASE_TYPE`
 * Update the project's changelog file `CHANGELOG.md`
 * Create a release branch `release-v1.0.0`
 * Commit the changes to the version and changelog AND create a release tag (`v1.0.0`) pointing
@@ -320,33 +320,28 @@ Finally, publish your gem to rubygems.org with the command:
 rake release:rubygem_push
 ```
 
-## FAQ
+### Reverting `create-github-release`
 
-### What if I want to reverse the changes made by this script?
+Should you decide that `create-github-release` was run in error, the `revert-github-release`
+script is provided by this gem to revert the changes made.
 
-You will need to delete the Git tag and branch created by this script both remotely and locally.
+This script must be run before the release PR is merged to the default branch.
 
-In your worktree run the following commands:
+This script must be run in the root directory of the work tree with the release
+branch checked out. This is the state that the `create-github-release` script leaves
+you in.
 
-```shell
-DEFAULT_BRANCH=main
-RELEASE_VERSION=1.0.1
-RELEASE_TAG="v${RELEASE_VERSION}"
-RELEASE_BRANCH="release_${RELEASE_TAG}"
-REMOTE=origin
-
-# Make sure the release branch is not checked out
-git checkout "${DEFAULT_BRANCH}"
-
-# Delete remote branch and tag
-# Deleting the remote branch will automatically close the release PR
-git push "${REMOTE}" --delete "${RELEASE_BRANCH}"
-git push "${REMOTE}" --delete "${RELEASE_TAG}"
-
-# Delete the local branch and tag
-git branch -D "${RELEASE_BRANCH}"
-git tag -d "${RELEASE_TAG}"
-```
+This script does the following:
+
+* Adds a comment to the release PR noting that it will be reverted
+* Switches the work tree to the default branch so the release branch can be deleted
+* Deletes the local release branch and release tag
+* Deletes the remote release branch and release tag
+* Deletes the release object created in GitHub for this release
+
+Deleting the release branch on the remote will automatically close the release PR.
+
+## FAQ
 
 ### How is the changelog updated?
 

data/create_github_release.gemspec

@@ -35,17 +35,16 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'semverify', '~> 0.3'
+  spec.add_runtime_dependency 'version_boss', '~> 0.1'
 
   spec.add_development_dependency 'bundler-audit', '~> 0.9'
-  spec.add_development_dependency 'debug', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 13.0'
-  spec.add_development_dependency 'redcarpet', '~> 3.5'
-  spec.add_development_dependency 'rspec', '~> 3.10'
-  spec.add_development_dependency 'rubocop', '~> 1.36'
-  spec.add_development_dependency 'simplecov', '~> 0.21'
+  spec.add_development_dependency 'debug', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 13.2'
+  spec.add_development_dependency 'redcarpet', '~> 3.6'
+  spec.add_development_dependency 'rspec', '~> 3.13'
+  spec.add_development_dependency 'rubocop', '~> 1.63'
+  spec.add_development_dependency 'simplecov', '~> 0.22'
   spec.add_development_dependency 'simplecov-lcov', '~> 0.8'
-  # spec.add_development_dependency 'solargraph', '~> 0.49'
   spec.add_development_dependency 'timecop', '~> 0.9'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'yardstick', '~> 0.9'

data/exe/create-github-release

@@ -3,6 +3,28 @@
 
 require 'create_github_release'
 
+# Call method up to max_attempts times until it returns a non-nil value
+#
+# @param method [Proc] the method to call
+# @param max_attempts [Integer] the maximum number of attempts to make
+# @param sleep_time [Float] the number of seconds to sleep between attempts
+#
+# @return [Object] the result of the method call or nil
+#
+# @api public
+#
+def wait_for_non_nil(method, max_attempts: 10, sleep_time: 0.5)
+  result = nil
+
+  max_attempts.times do |n|
+    sleep sleep_time unless n.zero?
+
+    break if (result = method.call)
+  end
+
+  result
+end
+
 options = CreateGithubRelease::CommandLine::Parser.new.parse(*ARGV)
 pp options if options.verbose
 
@@ -13,28 +35,29 @@ puts unless options.quiet
 CreateGithubRelease::ReleaseTasks.new(project).run
 
 puts <<~MESSAGE unless project.quiet
+
   SUCCESS: created release '#{project.next_release_tag}'
 
   Next steps:
 
   * Review the release notes:
 
-  #{project.release_url}
+      #{project.release_url}
 
   * Get someone to review and approve the release pull request:
 
-  #{project.release_pr_url}
+      #{wait_for_non_nil(-> { project.release_pr_url }, max_attempts: 10, sleep_time: 0.5)}
 
   * Merge the pull request manually from the command line with the following
     commands:
 
-  git checkout #{project.default_branch}
-  git merge --ff-only #{project.release_branch}
-  git push
+      git checkout #{project.default_branch}
+      git merge --ff-only #{project.release_branch}
+      git push
 
   * Wait for the CI build to pass on the default branch and then release the
     gem with the following command:
 
-  rake release:rubygem_push
+      rake release:rubygem_push
 
 MESSAGE

data/exe/revert-github-release

@@ -15,7 +15,7 @@ class Options
   attr_writer :default_branch, :release_version, :release_tag, :release_branch, :current_branch, :remote
 
   def default_branch = @default_branch ||= 'main'
-  def release_version = @release_version ||= `semverify current`.chomp
+  def release_version = @release_version ||= `gem-version-boss current`.chomp
   def release_tag = @release_tag ||= "v#{release_version}"
   def release_branch = @release_branch ||= "release-#{release_tag}"
   def current_branch = @current_branch ||= `git rev-parse --abbrev-ref HEAD`.chomp

data/lib/create_github_release/command_line/parser.rb

@@ -222,7 +222,8 @@ module CreateGithubRelease
       # @return [void]
       # @api private
       def define_last_release_version_option
-        option_parser.on('--last-release-version=VERSION', 'Use this version instead `semverify current`') do |version|
+        option_parser.on('--last-release-version=VERSION',
+                         'Use this version instead `gem-version-boss current`') do |version|
           options.last_release_version = version
         end
       end
@@ -233,7 +234,7 @@ module CreateGithubRelease
       def define_next_release_version_option
         option_parser.on(
           '--next-release-version=VERSION',
-          'Use this version instead `semverify next-RELEASE_TYPE`'
+          'Use this version instead `gem-version-boss next-RELEASE_TYPE`'
         ) do |version|
           options.next_release_version = version
         end

data/lib/create_github_release/project.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'semverify'
+require 'version_boss'
 require 'uri'
 
 module CreateGithubRelease
@@ -194,7 +194,7 @@ module CreateGithubRelease
     #
     # The version of the next release
     #
-    # @example By default, `next_release_version` is based on the value returned by `semverify <release_type> --dry-run`
+    # @example By default, `next_release_version` is based on `gem-version-boss <release_type> --dry-run`
     #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.next_release_version #=> '1.0.0'
@@ -207,7 +207,7 @@ module CreateGithubRelease
     #
     # @return [String]
     #
-    # @raise [RuntimeError] if the semverify command fails
+    # @raise [RuntimeError] if the gem-version-boss command fails
     #
     # @api public
     #
@@ -245,7 +245,7 @@ module CreateGithubRelease
     #
     # The version of the last release
     #
-    # @example By default, `last_release_version` is based on the value returned by `semverify current`
+    # @example By default, `last_release_version` is based on the value returned by `gem-version-boss current`
     #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.last_release_version #=> '0.0.1'
@@ -258,7 +258,7 @@ module CreateGithubRelease
     #
     # @return [String]
     #
-    # @raise [RuntimeError] if the semverify command fails
+    # @raise [RuntimeError] if the gem-version-boss command fails
     #
     # @api public
     #
@@ -284,7 +284,7 @@ module CreateGithubRelease
     #
     # @return [String]
     #
-    # @raise [RuntimeError] if the semverify command fails
+    # @raise [RuntimeError] if the gem-version-boss command fails
     #
     # @api public
     #
@@ -312,7 +312,7 @@ module CreateGithubRelease
     #
     # @return [URI]
     #
-    # @raise [RuntimeError] if the semverify command fails
+    # @raise [RuntimeError] if the gem-version-boss command fails
     #
     # @api public
     #
@@ -369,7 +369,7 @@ module CreateGithubRelease
     #
     # The type of the release being created (e.g. 'major', 'minor', 'patch')
     #
-    # @note this must be one of the values accepted by the `semverify` command
+    # @note this must be one of the values accepted by the `gem-version-boss` command
     #
     # @example By default, this value comes from the options object
     #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
@@ -913,22 +913,22 @@ module CreateGithubRelease
 
     private
 
-    # The current version of the project as determined by semverify
+    # The current version of the project as determined by gem-version-boss
     # @return [String] The current version of the project
     # @api private
     def current_version
-      output = `semverify current`
-      raise 'Could not determine current version using semverify' unless $CHILD_STATUS.success?
+      output = `gem-version-boss current`
+      raise 'Could not determine current version using gem-version-boss' unless $CHILD_STATUS.success?
 
       output.lines.last.chomp
     end
 
-    # The next version of the project as determined by semverify and release_type
+    # The next version as determined by gem-version-boss and release_type
     # @return [String] The next version of the project
     # @api private
     def next_version
       output = `#{next_version_cmd}`
-      raise 'Could not determine next version using semverify' unless $CHILD_STATUS.success?
+      raise 'Could not determine next version using gem-version-boss' unless $CHILD_STATUS.success?
 
       output.lines.last.chomp
     end
@@ -937,7 +937,7 @@ module CreateGithubRelease
     # @return [String]
     # @api private
     def next_version_cmd
-      cmd = "semverify next-#{release_type}"
+      cmd = "gem-version-boss next-#{release_type}"
       cmd << ' --pre' if pre
       cmd << " --pre-type=#{pre_type}" if pre_type
       cmd << ' --dry-run'

data/lib/create_github_release/tasks/update_version.rb

@@ -5,12 +5,12 @@ require 'create_github_release/task_base'
 
 module CreateGithubRelease
   module Tasks
-    # Update the gem version using semverify
+    # Update the gem version using gem-version-boss
     #
     # @api public
     #
     class UpdateVersion < TaskBase
-      # Update the gem version using semverify
+      # Update the gem version using gem-version-boss
       #
       # @example
       #   require 'create_github_release'
@@ -39,28 +39,28 @@ module CreateGithubRelease
 
       private
 
-      # Increment the version using semverify
+      # Increment the version using gem-version-boss
       # @return [void]
       # @api private
       def increment_version
-        command = "semverify next-#{project.release_type}"
+        command = "gem-version-boss next-#{project.release_type}"
         command += ' --pre' if project.pre
         command += " --pre-type=#{project.pre_type}" if project.pre_type
         `#{command}`
         error 'Could not increment version' unless $CHILD_STATUS.success?
       end
 
-      # Return the path the the version file using semverify
+      # Return the path the the version file using gem-version-boss
       # @return [String]
       # @api private
       def version_file
-        output = `semverify file`
-        error 'Semverify could determine the version file' unless $CHILD_STATUS.success?
+        output = `gem-version-boss file`
+        error 'Could determine the version file' unless $CHILD_STATUS.success?
 
         output.lines.last.chomp
       end
 
-      # Identify the version file using semverify and stage the change to it
+      # Identify the version file using gem-version-boss and stage the change to it
       # @return [void]
       # @api private
       def stage_version_file

data/lib/create_github_release/version.rb

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

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: create_github_release
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - James
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-09 00:00:00.000000000 Z
+date: 2024-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: semverify
+  name: version_boss
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: bundler-audit
   requirement: !ruby/object:Gem::Requirement
@@ -44,84 +44,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.9'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '13.2'
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: '3.13'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '1.63'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.36'
+        version: '1.63'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.22'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.21'
+        version: '0.22'
 - !ruby/object:Gem::Dependency
   name: simplecov-lcov
   requirement: !ruby/object:Gem::Requirement
@@ -250,8 +250,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.3.3/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/create_github_release/1.3.3
+  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
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -268,7 +268,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: A script to create a GitHub release for a Ruby Gem