create_github_release 1.3.3 → 1.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aaae536c7d44e9ced42bb4598ebf91b3e803766c3a9b6283185fee4c7327c3db
-  data.tar.gz: bbbb70f42b368e513d419b2c16490b8ef48d4f6269df342f5d23db6e3088927c
+  metadata.gz: b1b06e7f2c3125675b3b74014f25ed8a3b959d72b4c8f5c0f3740ea233362922
+  data.tar.gz: f49f1146fa4e77186582c17cd792a69a3ec6336b438d1a4bbda24d3e6c2bae0c
 SHA512:
-  metadata.gz: c3b4a8e4380a61ade20ea5833f7016bed6c5e056b37e78fb2cc6f589fcdce575d0cdd998c1d920507a3b2e6bca16837f99a02724e8d88e01ef9f00e1c9d066ff
-  data.tar.gz: df667078c1f6b9baccb7736a715343c8271dd3054ec42b96fa5bfb1115f955014a3f59f297e2d9cbdd15546dc787383e663c9eb0f756651e8ac812d5d4c35c32
+  metadata.gz: 41c3df4e14cf923a32a6cb8848c219a81ce01a0f4ea766457517028e700e7bdeaa57bbca229313b964c810cded33fe2a036da6c1cdf0bf2821a8dc27e831047f
+  data.tar.gz: f7c60f95cfda504347bb13da17938b39a2844df6092e722880bb5b62fe6ec6c50cfe19d500eb5bb5162fbfd25aece3fe13eb27876cb3ade24c6301f97c235ba6

data/CHANGELOG.md

@@ -5,6 +5,16 @@ 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)

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,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/lib/create_github_release/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: create_github_release
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.3.4
 platform: ruby
 authors:
 - James
@@ -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.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: []