create_github_release 1.3.2 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad4b627e248269d5ca7f6b8118c8ec5a1c612b066b091655ef7d0826d395f494
-  data.tar.gz: bcbeb39161236026fb130678a8539d1bbdf6b363ab5acf40dcacb6b4dbfaa3eb
+  metadata.gz: b1b06e7f2c3125675b3b74014f25ed8a3b959d72b4c8f5c0f3740ea233362922
+  data.tar.gz: f49f1146fa4e77186582c17cd792a69a3ec6336b438d1a4bbda24d3e6c2bae0c
 SHA512:
-  metadata.gz: d851c6e20196cdefd52601d088a4a5d8bb6e2ce687e19e4efb1beba5f10beeb2e0103df378bd4d9ade245a0c95540d8351ee6be8687e5c94f2943de6a2a64d7b
-  data.tar.gz: 6640d305d84d987b7645fcedb2c2a2b3e17d423d619c256584b442fcfdc44c8354170d96fb07646b32da8d2f496cb48ea9b9bf278591014dadd058f6bdf47975
+  metadata.gz: 41c3df4e14cf923a32a6cb8848c219a81ce01a0f4ea766457517028e700e7bdeaa57bbca229313b964c810cded33fe2a036da6c1cdf0bf2821a8dc27e831047f
+  data.tar.gz: f7c60f95cfda504347bb13da17938b39a2844df6092e722880bb5b62fe6ec6c50cfe19d500eb5bb5162fbfd25aece3fe13eb27876cb3ade24c6301f97c235ba6

data/CHANGELOG.md

@@ -5,6 +5,24 @@ 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.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)
+
+Changes since v1.3.2:
+
+* 69c7a3f Show release PR URL and other minor changes in the output. (#54)
+
 ## v1.3.2 (2024-01-08)
 
 [Full Changelog](https://github.com/main-branch/create_github_release/compare/v1.3.1..v1.3.2)

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)
@@ -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/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,18 +35,29 @@ puts unless options.quiet
 CreateGithubRelease::ReleaseTasks.new(project).run
 
 puts <<~MESSAGE unless project.quiet
-  Release '#{project.next_release_tag}' created successfully
-  See the release notes at #{project.release_url}
+
+  SUCCESS: created release '#{project.next_release_tag}'
 
   Next steps:
-  * Get someone to review and approve the release pull request
-  * 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
+  * Review the release notes:
+
+      #{project.release_url}
+
+  * Get someone to review and approve the release pull request:
+
+      #{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
+
+  * Wait for the CI build to pass on the default branch and then release the
+    gem with the following command:
 
-  Wait for the CI build to pass and then release the gem with the following command:
+      rake release:rubygem_push
 
-  rake release:rubygem_push
 MESSAGE

data/exe/revert-github-release

@@ -86,11 +86,13 @@ class Parser
     It must be run in the root directory of the work tree with the release
     branch checked out (which is the state create-github-release leaves you in).
 
-    This script should be run beefore the release PR is merged.
+    This script should be run before the release PR is merged.
 
-    This script removes the release branch and release tag both in the local
-    repository and on the remote. Deleting the branch on GitHub will close the
-    GitHub PR automatically.
+    This script does the following:
+      * Deletes the local and remote release branch
+      * Deletes the local and remote release tag
+      * Deletes the GitHub release object
+      * Closes the GitHub release PR
 
     Options:
   BANNER
@@ -172,4 +174,4 @@ end
 
 revert_release!(options)
 
-puts "Reverted release #{options.release_version}"
+puts "SUCCESS: reverted release '#{options.release_version}'"

data/lib/create_github_release/project.rb

@@ -69,7 +69,7 @@ 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
+      :first_commit, :verbose, :quiet, :release_pr_number, :release_pr_url
 
     # attr_writer :first_release
 
@@ -324,6 +324,47 @@ module CreateGithubRelease
       end
     end
 
+    # @!attribute [rw] release_pr_number
+    #
+    # The number of the pull request created for the release or nil
+    #
+    # The PR must already exist.
+    #
+    # @example
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
+    #   project = CreateGithubRelease::Project.new(options)
+    #   project.release_pr_number #=> '123'
+    #
+    # @return [String, nil]
+    #
+    # @api public
+    #
+    def release_pr_number
+      @release_pr_number ||= begin
+        pr_number = `gh pr list --search "head:#{release_branch}" --json number --jq ".[].number"`.chomp
+        pr_number.empty? ? nil : pr_number
+      end
+    end
+
+    # @!attribute [rw] release_pr_url
+    #
+    # The url of the pull request created for the release or nil
+    #
+    # The PR must already exist.
+    #
+    # @example
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
+    #   project = CreateGithubRelease::Project.new(options)
+    #   project.release_pr_url #=> 'https://github.com/org/repo/pull/123'
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    def release_pr_url
+      @release_pr_url ||= release_pr_number.nil? ? nil : URI.parse("#{remote_url}/pull/#{release_pr_number}")
+    end
+
     # @!attribute [rw] release_type
     #
     # The type of the release being created (e.g. 'major', 'minor', 'patch')
@@ -713,12 +754,15 @@ module CreateGithubRelease
         CreateGithubRelease::Changelog.new(last_release_changelog, next_release_description).to_s
     end
 
+    # rubocop:disable Metrics/AbcSize
+
     # Show the project details as a string
     #
     # @example
     #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   puts projects.to_s
+    #   first_release: false
     #   default_branch: main
     #   next_release_tag: v1.0.0
     #   next_release_date: 2023-02-01
@@ -733,6 +777,8 @@ module CreateGithubRelease
     #   remote_base_url: https://github.com/
     #   remote_repository: org/repo
     #   remote_url: https://github.com/org/repo
+    #   release_pr_number: 123
+    #   release_pr_url: https://github.com/org/repo/pull/123
     #   changelog_path: CHANGELOG.md
     #   verbose?: false
     #   quiet?: false
@@ -758,11 +804,16 @@ module CreateGithubRelease
         remote_base_url: #{remote_base_url}
         remote_repository: #{remote_repository}
         remote_url: #{remote_url}
+        release_pr_number: #{release_pr_number}
+        release_pr_url: #{release_pr_url}
+        changelog_path: #{changelog_path}
         verbose?: #{verbose?}
         quiet?: #{quiet?}
       OUTPUT
     end
 
+    # rubocop:enable Metrics/AbcSize
+
     # @!attribute [rw] verbose
     #
     # If `true` enables verbose output

data/lib/create_github_release/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: create_github_release
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.3.4
 platform: ruby
 authors:
 - James
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semverify
@@ -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.2/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/create_github_release/1.3.2
+  changelog_uri: https://rubydoc.info/gems/create_github_release/1.3.4/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/create_github_release/1.3.4
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []