create_github_release 1.3.1 → 1.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8dd471fba24b22c130b2d03d534e44b46753300a3e41ff08bb8d68b93e6cdee
-  data.tar.gz: 51d08847e10a5856b3a94fd7ee774ca104e47db954bdf73ea1fc4749529600b9
+  metadata.gz: aaae536c7d44e9ced42bb4598ebf91b3e803766c3a9b6283185fee4c7327c3db
+  data.tar.gz: bbbb70f42b368e513d419b2c16490b8ef48d4f6269df342f5d23db6e3088927c
 SHA512:
-  metadata.gz: f926991f50c625bdbef00025bdb7f618268c1e1eba763bd320ef38e94885ea3da8a626e5f3b3747e6def444653fa33cb88bcc751cf0fa1403dee518a704afa7c
-  data.tar.gz: e520e45d0015579988f9bbb554afe065e2169905be3dcf6fd36d8bf0191f157eb865080db6205d12acccbc390e23543ca7fbcbffa324c75e99bda61e3bc7b9b9
+  metadata.gz: c3b4a8e4380a61ade20ea5833f7016bed6c5e056b37e78fb2cc6f589fcdce575d0cdd998c1d920507a3b2e6bca16837f99a02724e8d88e01ef9f00e1c9d066ff
+  data.tar.gz: df667078c1f6b9baccb7736a715343c8271dd3054ec42b96fa5bfb1115f955014a3f59f297e2d9cbdd15546dc787383e663c9eb0f756651e8ac812d5d4c35c32

data/CHANGELOG.md

@@ -5,6 +5,22 @@ 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.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)
+
+Changes since v1.3.1:
+
+* 6b0e295 Delete the release in GitHub and add a comment to the release PR (#52)
+
 ## v1.3.1 (2024-01-08)
 
 [Full Changelog](https://github.com/main-branch/create_github_release/compare/v1.3.0..v1.3.1)

data/exe/create-github-release

@@ -13,18 +13,28 @@ 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:
+
+  * Review the release notes:
+
+  #{project.release_url}
+
+  * Get someone to review and approve the release pull request:
+
+  #{project.release_pr_url}
+
+  * 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 and then release the gem with the following command:
+  * Wait for the CI build to pass on the default branch and then release the
+    gem with the following command:
 
   rake release:rubygem_push
+
 MESSAGE

data/exe/revert-github-release

@@ -19,6 +19,7 @@ class Options
   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
+  def release_pr = @release_pr ||= `gh pr list --search "head:#{release_branch}" --json number --jq ".[].number"`.chomp
   def remote = @remote ||= 'origin'
 end
 
@@ -79,15 +80,19 @@ class Parser
     Usage:
     #{File.basename($PROGRAM_NAME)} [--help | --version]
 
+    Version #{CreateGithubRelease::VERSION}
+
     This script reverts the effect of running the create-github-release script.
     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
@@ -139,6 +144,16 @@ def ref_exists?(name)
   $CHILD_STATUS.success?
 end
 
+def revert_release!(options)
+  `gh pr comment #{options.release_pr} --body="Reverting this release using revert-github-release"`
+  `git checkout #{options.default_branch} >/dev/null`
+  `git branch -D #{options.release_branch} >/dev/null`
+  `git tag -d #{options.release_tag} >/dev/null`
+  `git push #{options.remote} --delete #{options.release_branch} >/dev/null`
+  `git push #{options.remote} --delete #{options.release_tag} >/dev/null`
+  `gh release delete #{options.release_tag} --yes >/dev/null`
+end
+
 unless in_work_tree? && in_root_directory?
   warn 'ERROR: Not in the root directory of a Git work tree'
   exit 1
@@ -157,10 +172,6 @@ unless ref_exists?(options.default_branch)
   exit 1
 end
 
-`git checkout #{options.default_branch} >/dev/null`
-`git branch -D #{options.release_branch} >/dev/null`
-`git tag -d #{options.release_tag} >/dev/null`
-`git push #{options.remote} --delete #{options.release_branch} >/dev/null`
-`git push #{options.remote} --delete #{options.release_tag} >/dev/null`
+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.1'
+  VERSION = '1.3.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: create_github_release
 version: !ruby/object:Gem::Version
-  version: 1.3.1
+  version: 1.3.3
 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.1/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/create_github_release/1.3.1
+  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
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []