create_github_release 0.2.1 → 1.0.0

data/lib/create_github_release/release_assertions.rb

@@ -55,13 +55,13 @@ module CreateGithubRelease
       CreateGithubRelease::Assertions::NoUncommittedChanges,
       CreateGithubRelease::Assertions::NoStagedChanges,
       CreateGithubRelease::Assertions::LocalAndRemoteOnSameCommit,
+      CreateGithubRelease::Assertions::LastReleaseTagExists,
       CreateGithubRelease::Assertions::LocalReleaseTagDoesNotExist,
       CreateGithubRelease::Assertions::RemoteReleaseTagDoesNotExist,
       CreateGithubRelease::Assertions::LocalReleaseBranchDoesNotExist,
       CreateGithubRelease::Assertions::RemoteReleaseBranchDoesNotExist,
-      CreateGithubRelease::Assertions::DockerIsRunning,
-      CreateGithubRelease::Assertions::ChangelogDockerContainerExists,
-      CreateGithubRelease::Assertions::GhCommandExists
+      CreateGithubRelease::Assertions::GhCommandExists,
+      CreateGithubRelease::Assertions::GhAuthenticated
     ].freeze
 
     # Run all assertions

data/lib/create_github_release/release_tasks.rb

@@ -46,11 +46,11 @@ module CreateGithubRelease
     # @return [Array<Class>] The tasks that will be run to create a new Github release
     #
     TASKS = [
-      CreateGithubRelease::Tasks::CreateReleaseTag,
       CreateGithubRelease::Tasks::CreateReleaseBranch,
       CreateGithubRelease::Tasks::UpdateVersion,
       CreateGithubRelease::Tasks::UpdateChangelog,
       CreateGithubRelease::Tasks::CommitRelease,
+      CreateGithubRelease::Tasks::CreateReleaseTag,
       CreateGithubRelease::Tasks::PushRelease,
       CreateGithubRelease::Tasks::CreateGithubRelease,
       CreateGithubRelease::Tasks::CreateReleasePullRequest

data/lib/create_github_release/task_base.rb

@@ -9,11 +9,14 @@ module CreateGithubRelease
   # @api private
   #
   class TaskBase
-    # Create a new tasks object and save the given `options`
-    # @param options [CreateGithubRelease::Options] the options
+    # Create a new tasks object and save the given `project`
+    # @param project [CreateGithubRelease::Project] the project to create the release for
     # @api private
-    def initialize(options)
-      @options = options
+    def initialize(project)
+      raise ArgumentError, 'project must be a CreateGithubRelease::Project' unless
+        project.is_a?(CreateGithubRelease::Project)
+
+      @project = project
     end
 
     # This method must be overriden by a subclass
@@ -27,27 +30,27 @@ module CreateGithubRelease
       raise NotImplementedError
     end
 
-    # @!attribute [r] options
+    # @!attribute [r] project
     #
-    # The options passed to the task object
-    # @return [CreateGithubRelease::Options] the options
+    # The project passed to the task object
+    # @return [CreateGithubRelease::Project]
     # @api private
-    attr_reader :options
+    attr_reader :project
 
     # Calls `Kernel.print` if the `quiet` flag is not set in the `options`
     # @param args [Array] the arguments to pass to `Kernel.print`
     # @return [void]
     # @api private
     def print(*args)
-      super unless options.quiet
+      super unless project.quiet?
     end
 
-    # Calls `Kernel.puts` if the `quiet` flag is not set in the `options`
+    # Calls `Kernel.puts` if the `quiet` flag is not set in the `project`
     # @param args [Array] the arguments to pass to `Kernel.puts`
     # @return [void]
     # @api private
     def puts(*args)
-      super unless options.quiet
+      super unless project.quiet?
     end
 
     # Writes a message to stderr and exits with exitcode 1
@@ -58,5 +61,16 @@ module CreateGithubRelease
       warn "ERROR: #{message}"
       exit 1
     end
+
+    # `true` if the `project.verbose?` flag is `true`
+    # @return [Boolean]
+    # @api private
+    def backtick_debug?
+      project.verbose?
+    end
+
+    # This overrides the backtick operator for this class to output debug
+    # information if `verbose?` is true
+    include CreateGithubRelease::BacktickDebug
   end
 end

data/lib/create_github_release/tasks/commit_release.rb

@@ -15,8 +15,9 @@ module CreateGithubRelease
       # @example
       #   require 'create_github_release'
       #
-      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
-      #   task = CreateGithubRelease::Tasks::CommitRelease.new(options)
+      #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'major' }
+      #   project = CreateGithubRelease::Project.new(options)
+      #   task = CreateGithubRelease::Tasks::CommitRelease.new(project)
       #   begin
       #     task.run
       #     puts 'Task completed successfully'
@@ -30,7 +31,7 @@ module CreateGithubRelease
       #
       def run
         print 'Making release commit...'
-        `git commit -s -m 'Release #{options.tag}'`
+        `git commit -s -m 'Release #{project.next_release_tag}'`
         if $CHILD_STATUS.success?
           puts 'OK'
         else

data/lib/create_github_release/tasks/create_github_release.rb

@@ -16,8 +16,9 @@ module CreateGithubRelease
       # @example
       #   require 'create_github_release'
       #
-      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
-      #   task = CreateGithubRelease::Tasks::CreateGithubRelease.new(options)
+      #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'major' }
+      #   project = CreateGithubRelease::Project.new(options)
+      #   task = CreateGithubRelease::Tasks::CreateGithubRelease.new(project)
       #   begin
       #     task.run
       #     puts 'Task completed successfully'
@@ -30,7 +31,7 @@ module CreateGithubRelease
       # @raise [SystemExit] if the task fails
       #
       def run
-        path = write_changelog_to_temp_file(generate_changelog)
+        path = write_release_description_to_tmp_file(project.next_release_description)
         begin
           create_github_release(path)
         ensure
@@ -43,10 +44,10 @@ module CreateGithubRelease
       # Create the gh command to create the Github release
       # @return [String] the command to run
       # @api private
-      def gh_command(default_branch, tag, changelog_path)
+      def gh_command(default_branch, tag, tmp_path)
         "gh release create '#{tag}' " \
           "--title 'Release #{tag}' " \
-          "--notes-file '#{changelog_path}' " \
+          "--notes-file '#{tmp_path}' " \
           "--target '#{default_branch}'"
       end
 
@@ -54,9 +55,9 @@ module CreateGithubRelease
       # @return [void]
       # @raise [SystemExit] if the gh command fails
       # @api private
-      def create_github_release(changelog_path)
-        print "Creating GitHub release '#{options.tag}'..."
-        `#{gh_command(options.default_branch, options.tag, changelog_path)}`
+      def create_github_release(tmp_path)
+        print "Creating GitHub release '#{project.next_release_tag}'..."
+        `#{gh_command(project.default_branch, project.next_release_tag, tmp_path)}`
         if $CHILD_STATUS.success?
           puts 'OK'
         else
@@ -64,43 +65,23 @@ module CreateGithubRelease
         end
       end
 
-      # Writes the changelog to a temporary file
-      # @return [void]
+      # Writes the release_description to a tmp file and returns the tmp file path
+      #
+      # The tmp file must be deleted by the caller.
+      #
+      # @return [String] the path to the tmp file that was create
       # @raise [SystemExit] if a temp file could not be created
       # @api private
-      def write_changelog_to_temp_file(changelog)
+      def write_release_description_to_tmp_file(release_description)
         begin
           f = Tempfile.create
         rescue StandardError => e
           error "Could not create a temporary file: #{e.message}"
         end
-        f.write(changelog)
+        f.write(release_description)
         f.close
         f.path
       end
-
-      # Build the command that generates the description of the new release
-      # @return [String] the command to run
-      # @api private
-      def docker_command(git_dir, from_tag, to_tag)
-        "docker run --rm --volume '#{git_dir}:/worktree' changelog-rs '#{from_tag}' '#{to_tag}'"
-      end
-
-      # Generate the description of the new release using docker
-      # @return [void]
-      # @raise [SystemExit] if the docker command fails
-      # @api private
-      def generate_changelog
-        print 'Generating changelog...'
-        command = docker_command(FileUtils.pwd, options.current_tag, options.next_tag)
-        `#{command}`.rstrip.lines[1..].join.tap do
-          if $CHILD_STATUS.success?
-            puts 'OK'
-          else
-            error 'Could not generate the changelog'
-          end
-        end
-      end
     end
   end
 end

data/lib/create_github_release/tasks/create_release_branch.rb

@@ -15,8 +15,9 @@ module CreateGithubRelease
       # @example
       #   require 'create_github_release'
       #
-      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
-      #   task = CreateGithubRelease::Tasks::CreateReleaseBranch.new(options)
+      #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'major' }
+      #   project = CreateGithubRelease::Project.new(options)
+      #   task = CreateGithubRelease::Tasks::CreateReleaseBranch.new(project)
       #   begin
       #     task.run
       #     puts 'Task completed successfully'
@@ -29,12 +30,12 @@ module CreateGithubRelease
       # @raise [SystemExit] if the task fails
       #
       def run
-        print "Creating branch '#{options.branch}'..."
-        `git checkout -b '#{options.branch}' > /dev/null 2>&1`
+        print "Creating branch '#{project.release_branch}'..."
+        `git checkout -b '#{project.release_branch}' > /dev/null 2>&1`
         if $CHILD_STATUS.success?
           puts 'OK'
         else
-          error "Could not create branch '#{options.branch}'" unless $CHILD_STATUS.success?
+          error "Could not create branch '#{project.release_branch}'" unless $CHILD_STATUS.success?
         end
       end
     end

data/lib/create_github_release/tasks/create_release_pull_request.rb

@@ -15,8 +15,9 @@ module CreateGithubRelease
       # @example
       #   require 'create_github_release'
       #
-      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
-      #   task = CreateGithubRelease::Tasks::CreateReleasePullRequest.new(options)
+      #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'major' }
+      #   project = CreateGithubRelease::Project.new(options)
+      #   task = CreateGithubRelease::Tasks::CreateReleasePullRequest.new(project)
       #   begin
       #     task.run
       #     puts 'Task completed successfully'
@@ -29,11 +30,11 @@ module CreateGithubRelease
       # @raise [SystemExit] if the task fails
       #
       def run
-        path = write_pr_body_to_temp_file(generate_changelog)
+        tmp_path = write_pr_body_to_tmp_file
         begin
-          create_release_pr(path)
+          create_release_pr(tmp_path)
         ensure
-          File.unlink(path)
+          File.unlink(tmp_path)
         end
       end
 
@@ -45,8 +46,8 @@ module CreateGithubRelease
       # @api private
       def create_release_pr(path)
         print 'Creating GitHub pull request...'
-        tag = options.tag
-        default_branch = options.default_branch
+        tag = project.next_release_tag
+        default_branch = project.default_branch
         `gh pr create --title 'Release #{tag}' --body-file '#{path}' --base '#{default_branch}'`
         if $CHILD_STATUS.success?
           puts 'OK'
@@ -55,53 +56,20 @@ module CreateGithubRelease
         end
       end
 
-      # The body of the pull request
-      # @return [String] the body of the pull request
-      # @api private
-      def pr_body(changelog)
-        <<~BODY.chomp
-          ## Change Log
-          #{changelog}
-        BODY
-      end
-
       # Write the changelog to a new temporary file
       # @return [String] the path to the temporary file
       # @raise [SystemExit] if the temp could not be created
       # @api private
-      def write_pr_body_to_temp_file(changelog)
+      def write_pr_body_to_tmp_file
         begin
           f = Tempfile.create
         rescue StandardError => e
           error "Could not create a temporary file: #{e.message}"
         end
-        f.write(pr_body(changelog))
+        f.write("# Release PR\n\n#{project.next_release_description}")
         f.close
         f.path
       end
-
-      # The command to list the changes in the relese
-      # @return [String] the command to run
-      # @api private
-      def docker_command(git_dir, from_tag, to_tag)
-        "docker run --rm --volume '#{git_dir}:/worktree' changelog-rs '#{from_tag}' '#{to_tag}'"
-      end
-
-      # Generate the list of changes in the release using docker
-      # @return [String] the list of changes
-      # @raise [SystemExit] if the docker command fails
-      # @api private
-      def generate_changelog
-        print 'Generating changelog...'
-        command = docker_command(FileUtils.pwd, options.current_tag, options.next_tag)
-        `#{command}`.rstrip.lines[1..].join.tap do
-          if $CHILD_STATUS.success?
-            puts 'OK'
-          else
-            error 'Could not generate the changelog'
-          end
-        end
-      end
     end
   end
 end

data/lib/create_github_release/tasks/create_release_tag.rb

@@ -15,8 +15,9 @@ module CreateGithubRelease
       # @example
       #   require 'create_github_release'
       #
-      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
-      #   task = CreateGithubRelease::Tasks::CreateReleaseTag.new(options)
+      #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'major' }
+      #   project = CreateGithubRelease::Project.new(options)
+      #   task = CreateGithubRelease::Tasks::CreateReleaseTag.new(project)
       #   begin
       #     task.run
       #     puts 'Task completed successfully'
@@ -29,12 +30,12 @@ module CreateGithubRelease
       # @raise [SystemExit] if the task fails
       #
       def run
-        print "Creating tag '#{options.tag}'..."
-        `git tag '#{options.tag}'`
+        print "Creating tag '#{project.next_release_tag}'..."
+        `git tag '#{project.next_release_tag}'`
         if $CHILD_STATUS.success?
           puts 'OK'
         else
-          error "Could not create tag '#{options.tag}'"
+          error "Could not create tag '#{project.next_release_tag}'"
         end
       end
     end

data/lib/create_github_release/tasks/push_release.rb

@@ -15,8 +15,9 @@ module CreateGithubRelease
       # @example
       #   require 'create_github_release'
       #
-      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
-      #   task = CreateGithubRelease::Tasks::PushRelease.new(options)
+      #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'major' }
+      #   project = CreateGithubRelease::Project.new(options)
+      #   task = CreateGithubRelease::Tasks::PushRelease.new(project)
       #   begin
       #     task.run
       #     puts 'Task completed successfully'
@@ -29,8 +30,8 @@ module CreateGithubRelease
       # @raise [SystemExit] if the task fails
       #
       def run
-        print "Pushing branch '#{options.branch}' to remote..."
-        `git push --tags --set-upstream '#{options.remote}' '#{options.branch}' > /dev/null 2>&1`
+        print "Pushing branch '#{project.release_branch}' to remote..."
+        `git push --tags --set-upstream '#{project.remote}' '#{project.release_branch}' > /dev/null 2>&1`
         if $CHILD_STATUS.success?
           puts 'OK'
         else

data/lib/create_github_release/tasks/update_changelog.rb

@@ -13,11 +13,15 @@ module CreateGithubRelease
     class UpdateChangelog < TaskBase
       # Update the changelog file with changes made since the last release
       #
+      # The changes since the last release are determined by using git log of all
+      # changes after the previous release tag up to and including HEAD.
+      #
       # @example
       #   require 'create_github_release'
       #
-      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
-      #   task = CreateGithubRelease::Tasks::UpdateChangelog.new(options)
+      #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'major' }
+      #   project = CreateGithubRelease::Project.new(options)
+      #   task = CreateGithubRelease::Tasks::UpdateChangelog.new(project)
       #   begin
       #     task.run
       #     puts 'Task completed successfully'
@@ -30,11 +34,7 @@ module CreateGithubRelease
       # @raise [SystemExit] if the task fails
       #
       def run
-        current_tag = options.current_tag
-        next_tag = options.next_tag
-        next_tag_date = next_tag_date(next_tag)
-        new_release = new_release(current_tag, next_tag, next_tag_date)
-        update_changelog(existing_changelog, new_release)
+        update_changelog
         stage_updated_changelog
       end
 
@@ -45,65 +45,13 @@ module CreateGithubRelease
       # @raise [SystemExit] if the git command fails
       # @api private
       def stage_updated_changelog
-        print 'Staging CHANGLOG.md...'
-
-        `git add CHANGELOG.md`
-        if $CHILD_STATUS.success?
-          puts 'OK'
-        else
-          error 'Could not stage changes to CHANGELOG.md'
-        end
-      end
-
-      # Read the existing changelog file
-      # @return [String] the contents of the changelog file
-      # @raise [SystemExit] if the file cannot be read
-      # @api private
-      def existing_changelog
-        @existing_changelog ||= begin
-          File.read('CHANGELOG.md')
-        rescue Errno::ENOENT
-          ''
-        end
-      end
-
-      # Find the date the release tag was created using git
-      # @return [Date] the date the release tag was created
-      # @raise [SystemExit] if the git command fails
-      # @api private
-      def next_tag_date(next_tag)
-        @next_tag_date ||= begin
-          print "Determining date #{next_tag} was created..."
-          date = `git show --format=format:%aI --quiet "#{next_tag}"`
-          if $CHILD_STATUS.success?
-            puts 'OK'
-            Date.parse(date)
-          else
-            error 'Could not stage changes to CHANGELOG.md'
-          end
-        end
-      end
+        print "Staging #{project.changelog_path}..."
 
-      # Build the command to list the changes since the last release
-      # @return [String] the command to list the changes since the last release
-      # @api private
-      def docker_command(git_dir, from_tag, to_tag)
-        "docker run --rm --volume '#{git_dir}:/worktree' changelog-rs '#{from_tag}' '#{to_tag}'"
-      end
-
-      # Generate the new release section of the changelog
-      # @return [CreateGithubRelease::Release] the new release section of the changelog
-      # @raise [SystemExit] if the docker command fails
-      # @api private
-      def new_release(current_tag, next_tag, next_tag_date)
-        print 'Generating release notes...'
-        command = docker_command(FileUtils.pwd, current_tag, next_tag)
-        release_description = `#{command}`.rstrip.lines[1..].join
+        `git add #{project.changelog_path}`
         if $CHILD_STATUS.success?
           puts 'OK'
-          ::CreateGithubRelease::Release.new(next_tag, next_tag_date, release_description)
         else
-          error 'Could not generate the release notes'
+          error "Could not stage changes to #{project.changelog_path}"
         end
       end
 
@@ -111,13 +59,14 @@ module CreateGithubRelease
       # @return [void]
       # @raise [SystemExit] if the file cannot be written
       # @api private
-      def update_changelog(existing_changelog, new_release)
-        print 'Updating CHANGELOG.md...'
-        changelog = ::CreateGithubRelease::Changelog.new(existing_changelog, new_release)
+      def update_changelog
+        print "Updating #{project.changelog_path}..."
         begin
-          File.write('CHANGELOG.md', changelog.to_s)
+          # File.open('debug.txt', 'w') { |f| f.write("CHANGELOG:\n#{project.next_release_changelog}") }
+          File.write(project.changelog_path, project.next_release_changelog)
         rescue StandardError => e
-          error "Could not write to CHANGELOG.md: #{e.message}"
+          # File.open('debug.txt', 'w') { |f| f.write("#{project.changelog_path}\n\nERROR:\n#{e.message}") }
+          error "Could not update #{project.changelog_path}: #{e.message}"
         end
         puts 'OK'
       end

data/lib/create_github_release/tasks/update_version.rb

@@ -15,8 +15,9 @@ module CreateGithubRelease
       # @example
       #   require 'create_github_release'
       #
-      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
-      #   task = CreateGithubRelease::Tasks::UpdateVersion.new(options)
+      #   options = CreateGithubRelease::CommandLineOptions.new { |o| o.release_type = 'major' }
+      #   project = CreateGithubRelease::Project.new(options)
+      #   task = CreateGithubRelease::Tasks::UpdateVersion.new(project)
       #   begin
       #     task.run
       #     puts 'Task completed successfully'
@@ -29,11 +30,38 @@ module CreateGithubRelease
       # @raise [SystemExit] if the task fails
       #
       def run
+        return if project.first_release?
+
         print 'Updating version...'
-        message, result = Bump::Bump.run(options.release_type, commit: false)
-        error "Could not bump version: #{message}" unless result.zero?
+        bump_version
+        stage_version_file
+      end
+
+      private
+
+      # Update the version using bump
+      # @return [void]
+      # @api private
+      def bump_version
+        `bump #{project.release_type} --no-commit`
+        error 'Could not bump version' unless $CHILD_STATUS.success?
+      end
+
+      # Return the path the the version file using bump
+      # @return [String]
+      # @api private
+      def bump_version_file
+        output = `bump file`
+        error 'Bump could determine the version file' unless $CHILD_STATUS.success?
 
-        version_file = Bump::Bump.file
+        output.lines.last.chomp
+      end
+
+      # Identify the version file using bump and stage the change to it
+      # @return [void]
+      # @api private
+      def stage_version_file
+        version_file = bump_version_file
         `git add "#{version_file}"`
         if $CHILD_STATUS.success?
           puts 'OK'

data/lib/create_github_release/version.rb

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

data/lib/create_github_release.rb

@@ -1,10 +1,12 @@
 # frozen_string_literal: true
 
+require 'create_github_release/backtick_debug'
+require 'create_github_release/command_line_options'
 require 'create_github_release/command_line_parser'
+require 'create_github_release/project'
 
+require 'create_github_release/change'
 require 'create_github_release/changelog'
-require 'create_github_release/options'
-require 'create_github_release/release'
 
 require 'create_github_release/assertion_base'
 require 'create_github_release/assertions'