create_github_release 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 046642a7818c8cf626e29d484eede363e25b9ab591ce134f2746fc18a4fa64f5
-  data.tar.gz: 6e652ca442a87c6160b029c388df237089e5e607de06f10fd388a2f9d84296ad
+  metadata.gz: 04e71e4f65e274c0bea5a1629d80b2f88689e547f07fa644b51cbaf480877122
+  data.tar.gz: f105cc39f93ff1c3f3cb85f8d675fb18163a4f1054130c3f3fa1871d7c22c66f
 SHA512:
-  metadata.gz: 24d892f156b5a01589f39822fb544475d7e14bf71aa864be551edc028422ddac3c12909aff95cca9bdb1ad92147e3d2f1b3dedc80435b6545d069245e3353cc4
-  data.tar.gz: dd56d32c64689bee2b44b4178f6c2b5ee324c540417b7e254e20b07f6aa856817b2dac65e97ec7aa29b960de786c9aba10eb1f3c3f755ae2a704287f1a0ad9ed
+  metadata.gz: 7c1b778ad46a00c912850f1cb09daacf6615f27cf1c8fbddaaa5f02a7c4e7cbc63a617868e431dca80aae6500b070c5d1b7fc2c50c7ccc1b0e363e2a332a122f
+  data.tar.gz: 7f2bd65c4ac7cadf6ec45a7c4fbf914a8287b7c99bab509a2618161002978bdcd805d8236161a2e6c47827de9a79577ca62eae5f47986c4ac6491c91df0cb850

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.0 (2024-01-08)
+
+[Full Changelog](https://github.com/main-branch/create_github_release/compare/v1.2.0..v1.3.0)
+
+Changes since v1.2.0:
+
+* fa6ddb2 Add option to create and revert scripts to show version (#48)
+* 954bea7 Add revert-github-release script (#47)
+* 564267a Correctly use semverify to increment pre-release versions (#46)
+
 ## v1.2.0 (2024-01-07)
 
 [Full Changelog](https://github.com/main-branch/create_github_release/compare/v1.1.0..v1.2.0)

data/README.md

@@ -345,7 +345,7 @@ git push "${REMOTE}" --delete "${RELEASE_TAG}"
 
 # Delete the local branch and tag
 git branch -D "${RELEASE_BRANCH}"
-git tag -D "${RELEASE_TAG}"
+git tag -d "${RELEASE_TAG}"
 ```
 
 ### How is the changelog updated?

data/exe/revert-github-release

@@ -0,0 +1,165 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# This script is used to revert a release that was created with the create-github-release gem
+# It will delete the release branch and tag locally and remotely
+
+require 'create_github_release'
+
+require 'English'
+require 'optparse'
+
+# Options for running this script
+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_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 remote = @remote ||= 'origin'
+end
+
+# Parse the command line options for this script
+class Parser
+  # Create a new command line parser
+  #
+  # @example
+  #   parser = CommandLineParser.new
+  #
+  def initialize
+    @option_parser = OptionParser.new
+    define_options
+    @options = Options.new
+  end
+
+  attr_reader :option_parser, :options
+
+  # Parse the command line arguements returning the options
+  #
+  # @example
+  #   options = Parser.new.parse(*ARGV)
+  #
+  # @param args [Array<String>] the command line arguments
+  #
+  # @return [Options] the options
+  #
+  def parse(*args)
+    begin
+      option_parser.parse!(remaining_args = args.dup)
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+      report_errors(e.message)
+    end
+    parse_remaining_args(remaining_args)
+    options
+  end
+
+  private
+
+  # Output an error message and useage to stderr and exit
+  # @return [void]
+  # @api private
+  def report_errors(*errors)
+    warn error_message(errors)
+    exit 1
+  end
+
+  # The command line template as a string
+  # @return [String]
+  # @api private
+  def command_template
+    <<~COMMAND
+      #{File.basename($PROGRAM_NAME)} [--help]
+    COMMAND
+  end
+
+  BANNER = <<~BANNER.freeze
+    Usage:
+    #{File.basename($PROGRAM_NAME)} [--help | --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 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.
+
+    Options:
+  BANNER
+
+  # Define the options for OptionParser
+  # @return [void]
+  # @api private
+  def define_options
+    option_parser.banner = BANNER
+    %i[
+      define_help_option define_version_option
+    ].each { |m| send(m) }
+  end
+
+  # Define the help option
+  # @return [void]
+  # @api private
+  def define_help_option
+    option_parser.on_tail('-h', '--help', 'Show this message') do
+      puts option_parser
+      exit 0
+    end
+  end
+
+  # Define the version option
+  # @return [void]
+  # @api private
+  def define_version_option
+    option_parser.on_tail('-v', '--version', 'Output the version of this script') do
+      puts CreateGithubRelease::VERSION
+      exit 0
+    end
+  end
+
+  # Parse non-option arguments
+  # @return [void]
+  # @api private
+  def parse_remaining_args(remaining_args)
+    # There should be no remaining args
+    report_errors('Too many args') unless remaining_args.empty?
+  end
+end
+
+def in_work_tree? = `git rev-parse --is-inside-work-tree 2>/dev/null`.chomp == 'true'
+def in_root_directory? = `git rev-parse --show-toplevel 2>/dev/null`.chomp == Dir.pwd
+
+def ref_exists?(name)
+  `git rev-parse --verify #{name} >/dev/null 2>&1`
+  $CHILD_STATUS.success?
+end
+
+unless in_work_tree? && in_root_directory?
+  warn 'ERROR: Not in the root directory of a Git work tree'
+  exit 1
+end
+
+# Parse the command line options
+options = Parser.new.parse(*ARGV)
+
+unless options.release_branch == options.current_branch
+  warn "ERROR: The current branch '#{options.current_branch}' is not the release branch for #{options.release_version}"
+  exit 1
+end
+
+unless ref_exists?(options.default_branch)
+  warn "ERROR: The default branch '#{options.default_branch}' does not exist"
+  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`
+
+puts "Reverted release #{options.release_version}"

data/lib/create_github_release/command_line/parser.rb

@@ -118,28 +118,27 @@ module CreateGithubRelease
         exit 1
       end
 
-      # The command line template as a string
-      # @return [String]
-      # @api private
-      def command_template
-        <<~COMMAND
-          #{File.basename($PROGRAM_NAME)} --help | RELEASE_TYPE [options]
-        COMMAND
-      end
+      # The banner for the option parser
+      BANNER = <<~BANNER.freeze
+        Usage:
+        #{File.basename($PROGRAM_NAME)} --help | RELEASE_TYPE [options]
+
+        Version #{CreateGithubRelease::VERSION}
+
+        RELEASE_TYPE must be 'major', 'minor', 'patch', 'pre', 'release', or 'first'
+
+        Options:
+      BANNER
 
       # Define the options for OptionParser
       # @return [void]
       # @api private
       def define_options
         # @sg-ignore
-        option_parser.banner = "Usage:\n#{command_template}"
-        option_parser.separator ''
-        option_parser.separator "RELEASE_TYPE must be 'major', 'minor', 'patch', 'pre', 'release', or 'first'"
-        option_parser.separator ''
-        option_parser.separator 'Options:'
+        option_parser.banner = BANNER
         %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_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
         ].each { |m| send(m) }
       end
@@ -176,7 +175,7 @@ module CreateGithubRelease
       # @return [void]
       # @api private
       def define_verbose_option
-        option_parser.on('-v', '--[no-]verbose', 'Show extra output') do |verbose|
+        option_parser.on('-V', '--[no-]verbose', 'Show extra output') do |verbose|
           options.verbose = verbose
         end
       end
@@ -247,6 +246,16 @@ module CreateGithubRelease
           options.changelog_path = name
         end
       end
+
+      # Define the version option
+      # @return [void]
+      # @api private
+      def define_version_option
+        option_parser.on_tail('-v', '--version', 'Output the version of this script') do
+          puts CreateGithubRelease::VERSION
+          exit 0
+        end
+      end
     end
     # rubocop:enable Metrics/ClassLength
   end

data/lib/create_github_release/tasks/update_version.rb

@@ -43,7 +43,10 @@ module CreateGithubRelease
       # @return [void]
       # @api private
       def increment_version
-        `semverify next-#{project.release_type}`
+        command = "semverify 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
 

data/lib/create_github_release/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: create_github_release
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - James
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-07 00:00:00.000000000 Z
+date: 2024-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: semverify
@@ -185,6 +185,7 @@ email:
 - jcouball@yahoo.com
 executables:
 - create-github-release
+- revert-github-release
 extensions: []
 extra_rdoc_files: []
 files:
@@ -201,6 +202,7 @@ files:
 - Rakefile
 - create_github_release.gemspec
 - exe/create-github-release
+- exe/revert-github-release
 - lib/create_github_release.rb
 - lib/create_github_release/assertion_base.rb
 - lib/create_github_release/assertions.rb
@@ -248,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.2.0/file/CHANGELOG.md
-  documentation_uri: https://rubydoc.info/gems/create_github_release/1.2.0
+  changelog_uri: https://rubydoc.info/gems/create_github_release/1.3.0/file/CHANGELOG.md
+  documentation_uri: https://rubydoc.info/gems/create_github_release/1.3.0
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []