create_github_release 1.1.0 → 1.3.0

data/lib/create_github_release/command_line/validator.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require_relative 'validations'
+
+module CreateGithubRelease
+  module CommandLine
+    # Validates a set of options after the options have been fully initialized
+    # @api private
+    class Validator
+      # Create a new instance of this class
+      # @param options [CreateGithubRelease::CommandLine::Options] the options to validate
+      # @api private
+      def initialize(options)
+        @options = options
+      end
+
+      # Returns `true` if all options are valid and `false` otherwise
+      #
+      # * If the options are valid, returns `true` clears the `#errors` array
+      # * If the options are not valid, returns `false` and populates the `#errors` array
+      #
+      # @example when all options are valid
+      #   options = CreateGithubRelease::CommandLine::Options.new
+      #   options.release_type = 'major'
+      #   options.valid? #=> true
+      #   options.errors #=> []
+      #
+      # @example when one or more options are not valid
+      #   options = CreateGithubRelease::CommandLine::Options.new
+      #   options.release_type #=> nil
+      #   options.valid? #=> false
+      #   options.errors #=> ["--release-type must be given and be one of 'major', 'minor', 'patch'"]
+      #
+      # @return [Boolean]
+      #
+      def valid?
+        @errors = []
+        validation_classes.each do |validation_class|
+          validation = validation_class.new(options)
+          @errors << validation.error unless validation.valid?
+        end
+        @errors.empty?
+      end
+
+      # Returns an array of error messages
+      #
+      # * If the options are valid, returns an empty array
+      # * If the options are not valid, returns an array of error messages
+      #
+      # @example when all options are valid
+      #   options = CreateGithubRelease::CommandLine::Options.new
+      #   options.release_type = 'major'
+      #   options.valid? #=> true
+      #   options.errors #=> []
+      #
+      # @example when one or more options are not valid
+      #   options = CreateGithubRelease::CommandLine::Options.new
+      #   options.release_type #=> nil
+      #   options.quiet = options.verbose = true
+      #   options.valid? #=> false
+      #   options.errors #=>  [
+      #     "Both --quiet and --verbose cannot be given",
+      #     "--release-type must be given and be one of 'major', 'minor', 'patch'"
+      #   ]
+      #
+      # @return [Array<String>] an array of error messages
+      #
+      def errors
+        valid?
+        @errors
+      end
+
+      private
+
+      # The options to validate
+      # @return [CreateGithubRelease::CommandLine::Options]
+      # @api private
+      attr_reader :options
+
+      # Returns an array of validation classes
+      # @return [Array<CreateGithubRelease::Validations::Base>]
+      # @api private
+      def validation_classes
+        [].tap do |validation_classes|
+          CreateGithubRelease::CommandLine::Validations.constants.each do |constant_name|
+            constant = Validations.const_get(constant_name)
+            validation_classes << constant if constant.is_a?(Class) && constant_name.to_s.start_with?('Validate')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/create_github_release/command_line.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module CreateGithubRelease
+  # This module has all the classes and modules for the command line interface
+  #
+  # The Parser class is the main interface. It parses and validates the command line
+  # arguments and returns an instance of the Options class.
+  #
+  # @example
+  #   parser = CreateGithubRelease::CommandLine::Parser.new
+  #   options = parser.parse(*ARGV)
+  #   if !option.valid?
+  #     puts options.errors
+  #     exit 1
+  #   end
+  #   # ... do something with the options
+  #
+  # @api public
+  #
+  module CommandLine
+    # An array of the valid release types
+    # @return [Array<String>]
+    # @api private
+    VALID_RELEASE_TYPES = %w[major minor patch pre release first].freeze
+
+    # Regex pattern for a [valid git reference](https://git-scm.com/docs/git-check-ref-format)
+    # @return [Regexp]
+    # @api private
+    VALID_REF_PATTERN = /^(?:(?:[a-zA-Z0-9-]+(?:\.[a-zA-Z0-9-]+)*)|(?:[a-zA-Z0-9-]+))$/
+
+    # An array of the allowed options that can be passed to `.new`
+    # @return [Array<Symbol>]
+    ALLOWED_OPTIONS = %i[
+      release_type pre pre_type default_branch release_branch remote last_release_version
+      next_release_version changelog_path quiet verbose
+    ].freeze
+  end
+end
+
+require_relative 'command_line/options'
+require_relative 'command_line/parser'
+require_relative 'command_line/validations'
+require_relative 'command_line/validator'

data/lib/create_github_release/project.rb

@@ -26,18 +26,18 @@ module CreateGithubRelease
     # used in the block passed to the initializer.
     #
     # @example calling `.new` without a block
-    #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'minor' }
+    #   options = CreateGithubRelease::CommandLine::Options.new { |o| o.release_type = 'minor' }
     #   project = CreateGithubRelease::Project.new(options)
     #   options.release_type = 'minor'
     #
     # @example calling `.new` with a block
-    #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'minor' }
+    #   options = CreateGithubRelease::CommandLine::Options.new { |o| o.release_type = 'minor' }
     #   project = CreateGithubRelease::Project.new(options) do |p|
     #     p.release_type = 'major'
     #   end
     #   options.release_type = 'major'
     #
-    # @param options [CreateGithubRelease::CommandLineOptions] the options to initialize the instance with
+    # @param options [CreateGithubRelease::CommandLine::Options] the options to initialize the instance with
     #
     # @yield [self] an initialization block
     # @yieldparam self [CreateGithubRelease::Project] the instance being initialized aka `self`
@@ -55,20 +55,21 @@ module CreateGithubRelease
     # The command line options used to initialize this project
     #
     # @example
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.options == options #=> true
     #
-    # @return [CreateGithubRelease::CommandLineOptions]
+    # @return [CreateGithubRelease::CommandLine::Options]
     #
     attr_reader :options
 
     attr_writer \
       :default_branch, :next_release_tag, :next_release_date, :next_release_version,
       :last_release_tag, :last_release_version, :release_branch, :release_log_url,
-      :release_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
+      :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
 
     # attr_writer :first_release
 
@@ -82,12 +83,12 @@ module CreateGithubRelease
     # Uses the value of `remote` to determine the remote repository to query.
     #
     # @example By default, `default_branch` is based on `git remote show`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   options.default_branch # => 'main'
     #
     # @example `default_branch` can be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.default_branch = 'master'
     #   project.default_branch #=> 'master'
@@ -114,13 +115,13 @@ module CreateGithubRelease
     # Uses the value of `next_release_version` to determine the tag name.
     #
     # @example By default, `next_release_tag` is based on `next_release_version`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.next_release_version = '1.0.0'
     #   project.next_relase_tag #=> 'v1.0.0'
     #
     # @example `next_tag` can be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.next_release_tag = 'v1.0.0'
     #   project.next_relase_tag #=> 'v1.0.0'
@@ -140,13 +141,13 @@ module CreateGithubRelease
     # If the next_release_tag does not exist, Date.today is returned.
     #
     # @example By default, `next_release_date` is based on `next_release_tag`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.next_release_tag = 'v1.0.0'
     #   project.next_release_date #=> #<Date: 2023-02-01 ((2459189j,0s,0n),+0s,2299161j)>
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.next_release_date = Date.new(2023, 2, 1)
     #   project.next_release_date #=> #<Date: 2023-02-01 ((2459189j,0s,0n),+0s,2299161j)>
@@ -172,7 +173,7 @@ module CreateGithubRelease
     # `true` if the given tag exists in the local repository
     #
     # @example
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.tag_exist?('v1.0.0') #=> false
     #
@@ -194,12 +195,12 @@ 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`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.next_release_version #=> '1.0.0'
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.next_release_version = '1.0.0
     #   project.next_release_version #=> '1.0.0'
@@ -221,13 +222,13 @@ module CreateGithubRelease
     # Uses the value of `last_release_version` to determine the tag name.
     #
     # @example By default, `last_release_tag` is based on `last_release_version`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.last_release_version = '0.0.1'
     #   project.last_relase_tag #=> 'v0.0.1'
     #
     # @example `last_release_tag` can be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.last_release_tag = 'v0.0.1'
     #   project.last_relase_tag #=> 'v0.0.1'
@@ -245,12 +246,12 @@ module CreateGithubRelease
     # The version of the last release
     #
     # @example By default, `last_release_version` is based on the value returned by `semverify current`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.last_release_version #=> '0.0.1'
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.last_release_version = '0.0.1
     #   project.last_release_version #=> '0.0.1'
@@ -270,13 +271,13 @@ module CreateGithubRelease
     # The name of the release branch being created
     #
     # @example By default, `release_branch` is based on the value returned by `next_release_tag`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.next_release_tag = 'v1.0.0'
     #   project.release_branch #=> 'release-v1.0.0'
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.next_release_branch = 'release-v1.0.0'
     #   project.next_release_branch #=> 'release-v1.0.0'
@@ -296,7 +297,7 @@ module CreateGithubRelease
     # The URL of the page containing a list of the changes in the release
     #
     # @example By default, `release_log_url` is based on `remote_url`, `last_release_tag`, and `next_release_tag`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote_url = URI.parse('https://github.com/org/repo')
     #   project.last_release_tag = 'v0.0.1'
@@ -304,7 +305,7 @@ module CreateGithubRelease
     #   project.release_log_url #=> #<URI::HTTPS https://github.com/org/repo/compare/v0.0.1..v1.0.0>
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.release_log_url = URI.parse('https://github.com/org/repo/compare/v0.0.1..v1.0.0')
     #   project.release_log_url #=> #<URI::HTTPS https://github.com/org/repo/compare/v0.0.1..v1.0.0>
@@ -330,12 +331,12 @@ module CreateGithubRelease
     # @note this must be one of the values accepted by the `semverify` command
     #
     # @example By default, this value comes from the options object
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.release_type #=> 'major'
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.release_type = 'patch'
     #   project.release_type #=> 'patch'
@@ -350,19 +351,66 @@ module CreateGithubRelease
       @release_type ||= options.release_type || raise(ArgumentError, 'release_type is required')
     end
 
+    # @!attribute [rw] pre
+    #
+    # Set to true if a pre-release is be created
+    #
+    # @example By default, this value comes from the options object
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major', pre: true, pre_type: 'alpha')
+    #   project = CreateGithubRelease::Project.new(options)
+    #   project.pre #=> 'true'
+    #
+    # @example It can also be set explicitly
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
+    #   project = CreateGithubRelease::Project.new(options)
+    #   project.pre = true
+    #   project.pre #=> true
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    #
+    def pre
+      @pre ||= options.pre
+    end
+
+    # @!attribute [rw] pre_type
+    #
+    # Set to the pre-release type to create. For example, "alpha", "beta", "pre", etc
+    #
+    # @example By default, this value comes from the options object
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major', pre: true, pre_type: 'alpha')
+    #   project = CreateGithubRelease::Project.new(options)
+    #   project.pre_type #=> 'alpha'
+    #
+    # @example It can also be set explicitly
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
+    #   project = CreateGithubRelease::Project.new(options)
+    #   project.pre = true
+    #   project.pre_type = 'alpha'
+    #   project.pre_type #=> 'alpha'
+    #
+    # @return [String]
+    #
+    # @api public
+    #
+    def pre_type
+      @pre_type ||= options.pre_type
+    end
+
     # @!attribute [rw] release_url
     #
     # The URL of the page containing a list of the changes in the release
     #
     # @example By default, `release_url` is based on `remote_url` and `next_release_tag`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote_url = URI.parse('https://github.com/org/repo')
     #   project.next_release_tag = 'v1.0.0'
     #   project.release_url #=> #<URI::HTTPS https://github.com/org/repo/releases/tag/v1.0.0>
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.release_url = URI.parse('https://github.com/org/repo/releases/tag/v1.0.0')
     #   project.release_url #=> #<URI::HTTPS https://github.com/org/repo/releases/tag/v1.0.0>
@@ -380,17 +428,17 @@ module CreateGithubRelease
     # The git remote used to determine the repository url
     #
     # @example By default, 'origin' is used
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote #=> 'origin'
     #
     # @example It can also be set in the options
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major', remote: 'upstream')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major', remote: 'upstream')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote #=> 'upstream'
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote = 'upstream'
     #   project.remote #=> 'upstream'
@@ -408,13 +456,13 @@ module CreateGithubRelease
     # The base part of the remote url (e.g. 'https://github.com/')
     #
     # @example By default, this value is based on `remote_url`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote_url = URI.parse('https://github.com/org/repo')
     #   project.remote #=> #<URI::HTTPS https://github.com/>
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote_base_url = URI.parse('https://github.com/')
     #   project.remote_base_url #=> #<URI::HTTPS https://github.com/>
@@ -432,13 +480,13 @@ module CreateGithubRelease
     # The git remote owner and repository name (e.g. 'org/repo')
     #
     # @example By default, this value is based on `remote_url`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote_url = URI.parse('htps://github.com/org/repo')
     #   project.remote_repository #=> 'org/repo'
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote_repository = 'org/repo'
     #
@@ -455,12 +503,12 @@ module CreateGithubRelease
     # The URL of the git remote repository (e.g. 'https://github.com/org/repo')
     #
     # @example By default, this value is based on `remote` and the `git remote get-url` command
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote #=> #<URI::HTTPS https://github.com/org/repo>
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote_url = URI.parse('https://github.com/org/repo')
     #   project.remote_url #=> #<URI::HTTPS https://github.com/org/repo>
@@ -485,17 +533,19 @@ module CreateGithubRelease
     # The path relative to the project root where the changelog is located
     #
     # @example By default, this value is 'CHANGELOG.md'
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.changelog_path #=> 'CHANGELOG.md'
     #
     # @example It can also be set in the options
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major', changelog_path: 'docs/CHANGES.txt')
+    #   options = CreateGithubRelease::CommandLine::Options.new(
+    #     release_type: 'major', changelog_path: 'docs/CHANGES.txt'
+    #   )
     #   project = CreateGithubRelease::Project.new(options)
     #   project.remote_repository = 'docs/CHANGES.txt'
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.changelog_path = 'docs/CHANGES.txt'
     #   project.remote_repository = 'docs/CHANGES.txt'
@@ -515,7 +565,7 @@ module CreateGithubRelease
     # Calls `git log HEAD <next_release_tag>` to list the changes.
     #
     # @example By default, uses `git log`
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   pp project.changes
     #   [
@@ -524,7 +574,7 @@ module CreateGithubRelease
     #   ]
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.changes = 'All the changes'
     #   project.changes #=> 'All the changes'
@@ -550,7 +600,7 @@ module CreateGithubRelease
     # The formatted release description
     #
     # @example
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options) do |p|
     #     p.remote_url = URI.parse('https://github.com/username/repo')
     #     p.last_release_tag = 'v0.1.0'
@@ -601,7 +651,7 @@ module CreateGithubRelease
     #
     #     * e718690 Release v0.1.0 (#3)
     #   CHANGELOG
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options) do |p|
     #     p.changelog_path = changelog_path
     #   end
@@ -634,7 +684,7 @@ module CreateGithubRelease
     # last_release_changelog.
     #
     # @example
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options) do |p|
     #     p.last_release_changelog = <<~CHANGELOG
     #       # Project Changelog
@@ -666,7 +716,7 @@ module CreateGithubRelease
     # Show the project details as a string
     #
     # @example
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   puts projects.to_s
     #   default_branch: main
@@ -718,12 +768,12 @@ module CreateGithubRelease
     # If `true` enables verbose output
     #
     # @example By default, this value is based on the `verbose` option
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major', verbose: true)
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major', verbose: true)
     #   project = CreateGithubRelease::Project.new(options)
     #   project.verbose? #=> true
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.verbose = true
     #   project.verbose? #=> true
@@ -743,12 +793,12 @@ module CreateGithubRelease
     # If `true` supresses all output
     #
     # @example By default, this value is based on the `quiet` option
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major', quiet: true)
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major', quiet: true)
     #   project = CreateGithubRelease::Project.new(options)
     #   project.quiet? #=> true
     #
     # @example It can also be set explicitly
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.quiet = true
     #   project.quiet? #=> true
@@ -768,12 +818,12 @@ module CreateGithubRelease
     # true if release_type is 'first' otherwise false
     #
     # @example Returns true if release_type is 'first'
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'first')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'first')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.first_release? #=> true
     #
     # @example Returnss false if release_type is not 'first'
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.first_release? #=> false
     #
@@ -792,7 +842,7 @@ module CreateGithubRelease
     # The SHA of the oldest commit that is an ancestor of HEAD
     #
     # @example
-    #   options = CreateGithubRelease::CommandLineOptions.new(release_type: 'major')
+    #   options = CreateGithubRelease::CommandLine::Options.new(release_type: 'major')
     #   project = CreateGithubRelease::Project.new(options)
     #   project.first_commit? #=> '1234567'
     #
@@ -826,12 +876,22 @@ module CreateGithubRelease
     # @return [String] The next version of the project
     # @api private
     def next_version
-      output = `semverify next-#{release_type} --dry-run`
+      output = `#{next_version_cmd}`
       raise 'Could not determine next version using semverify' unless $CHILD_STATUS.success?
 
       output.lines.last.chomp
     end
 
+    # Construct the command used to get the next version
+    # @return [String]
+    # @api private
+    def next_version_cmd
+      cmd = "semverify next-#{release_type}"
+      cmd << ' --pre' if pre
+      cmd << " --pre-type=#{pre_type}" if pre_type
+      cmd << ' --dry-run'
+    end
+
     # Setup versions and tags for a first release
     # @return [void]
     # @api private

data/lib/create_github_release/release_assertions.rb

@@ -24,7 +24,7 @@ module CreateGithubRelease
     #   assertions = CreateGithubRelease::ReleaseAssertions.new(options)
     #   assertions.options # => #<CreateGithubRelease::Options:0x00007f9b0a0b0a00>
     #
-    # @return [CreateGithubRelease::CommandLineOptions]
+    # @return [CreateGithubRelease::CommandLine::Options]
     attr_reader :options
 
     # Create a new instance of ReleaseAssertions

data/lib/create_github_release/release_tasks.rb

@@ -24,7 +24,7 @@ module CreateGithubRelease
     #   tasks = CreateGithubRelease::ReleaseTasks.new(options)
     #   tasks.options # => #<CreateGithubRelease::Options:0x00007f9b0a0b0a00>
     #
-    # @return [CreateGithubRelease::CommandLineOptions]
+    # @return [CreateGithubRelease::CommandLine::Options]
     attr_reader :options
 
     # Create a new instance of ReleaseTasks

data/lib/create_github_release/tasks/commit_release.rb

@@ -15,7 +15,7 @@ module CreateGithubRelease
       # @example
       #   require 'create_github_release'
       #
-      #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'major' }
+      #   options = CreateGithubRelease::CommandLine::Options.new { |o| o.release_type = 'major' }
       #   project = CreateGithubRelease::Project.new(options)
       #   task = CreateGithubRelease::Tasks::CommitRelease.new(project)
       #   begin

data/lib/create_github_release/tasks/create_github_release.rb

@@ -16,7 +16,7 @@ module CreateGithubRelease
       # @example
       #   require 'create_github_release'
       #
-      #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'major' }
+      #   options = CreateGithubRelease::CommandLine::Options.new { |o| o.release_type = 'major' }
       #   project = CreateGithubRelease::Project.new(options)
       #   task = CreateGithubRelease::Tasks::CreateGithubRelease.new(project)
       #   begin