create_github_release 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a06b294acfb6e5357f5fbba1f47b1c0baa64acb6f8b93f9ea5f3c262afb3ae1
+  data.tar.gz: 56dc6312fafcc3ca2b3244a9ba453651f17d2dfed4225830d2e594df48d2546c
+SHA512:
+  metadata.gz: 6119db8f31ca3a9e0d77d1fff5deb1b6fe66443d41024300469d6849542698de0e5af00163b12158ec480c22a330baeb321d765398c08adf30c52722367930ba
+  data.tar.gz: 791cfe69208757b5eba420a190150575686aeb554f4acde1dd584c3c22e282c3083e52e5d2e221e31aca4de2811ba783c14a00a61170b72c5d3f70fc1e012477

data/.markdownlint.yml

@@ -0,0 +1,25 @@
+default: true
+
+# Unordered list indentation
+MD007: { indent: 4 }
+
+# Line length
+MD013: { line_length: 90, tables: false, code_blocks: false }
+
+# Heading duplication is allowed for non-sibling headings
+MD024: { siblings_only: true }
+
+# Do not allow the specified trailig punctuation in a header
+MD026: { punctuation: '.,;:' }
+
+# Order list items must have a prefix that increases in numerical order
+MD029: { style: 'ordered' }
+
+# Lists do not need to be surrounded by blank lines
+MD032: false
+
+# Allow raw HTML in Markdown
+MD033: false
+
+# Allow emphasis to be used instead of a heading
+MD036: false

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  NewCops: enable
+  # Output extra information for each offense to make it easier to diagnose:
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+  ExtraDetails: true
+  SuggestExtensions: false
+  # RuboCop enforces rules depending on the oldest version of Ruby which
+  # your project supports:
+  TargetRubyVersion: 2.7
+
+# The default max line length is 80 characters
+Layout/LineLength:
+  Max: 120
+
+# The DSL for RSpec and the gemspec file make it very hard to limit block length:
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*_spec.rb"
+    - "*.gemspec"

data/.yardopts

@@ -0,0 +1,5 @@
+--no-private
+--hide-void-return
+--markup-provider=redcarpet
+--markup markdown
+- LICENSE.txt

data/CHANGELOG.md

@@ -0,0 +1,31 @@
+# Changelog
+
+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).
+
+## v0.2.0 (2022-11-15)
+
+[Full Changelog](https://github.com/main-branch/create_github_release/compare/v0.1.0...v0.2.0)
+
+* 039b152 Make it so Options#default_branch does not actually run git (#17)
+* 754224c Require date (#15)
+* 7789a28 Do not hardcode the version file path (#14)
+* 73b61bd Do not use unneeded regexps in tests (#13)
+* 6fa12e5 Create the release tag before trying to create the release branch (#12)
+* 819afd3 Call the right method for creating the release (#11)
+* 8a0fe61 Fix error in the create-github-release script (#10)
+* 6999d91 Execute the tasks from the create-github-release script (#9)
+* 819b657 Add a changelog file (#8)
+* 697fb95 Add 'tmp' and 'sig' directories to rake cleanup (#7)
+* 993e121 Add release tasks (#6)
+* a2d0b4d Add assertion to check that the git command is in the path (#5)
+* c3ed55b Refactor assertions (#4)
+* 0f3733e Add release assertions (#3)
+* a2c00ee Add the CommandLineParser class (#2)
+* 9535c0e Add the Options class (#1)
+
+## v0.1.0 (2022-10-26)
+
+* Initial version (976b790)

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in create_github_release.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 James Couball
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,64 @@
+# The create_github_release Gem
+
+Create a GitHub release for a new gem version.
+
+To create a new GitHub release for a gem, run the following from the top level
+project directory with the default branch selected:
+
+```shell
+create-github-release [major|minor|patch]
+```
+
+The following conditions must be met in order to create a release:
+
+* The bundle must be up to date (via bundle update)
+* You current directory must be in the top level of the git repository
+* The default branch must be checked out
+* There are no uncommitted changes
+* The local and remote must be on the same commit
+* The new release tag must not already exist either locally or remotely
+* The new release branch must not already exist either locally or remotely
+* Docker must be running
+* The changelog docker container must already exist or be able to be built
+* The gh command must be installed
+
+The result of running this command is:
+* A new release branch is created
+* CHANGELOG.md is updated with a list of PRs since the last release
+* The Gem version is updated via Bump
+* The CHANGELOG.md and version changes are committed and tagged on the new release branch
+* The new release branch is pushed to the remote
+* A release is created on GitHub
+* A release PR is created on GitHub
+
+## Installation
+
+Add `create_github_release` as a development dependency in your project's gemspec:
+
+```ruby
+spec.add_development_dependency 'create_github_release', '~> 0.1'
+```
+
+and then install using `bundle update`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake spec` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push git
+commits and the created tag, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on
+[this project's GitHub issue tracker](https://github.com/main-branch/create_github_release)
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](https://github.com/main-branch/create_github_release/blob/main/LICENSE.txt).

data/Rakefile

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+# The default task
+
+desc 'Run the same tasks that the CI build will run'
+task default: %w[spec rubocop yard yard:audit yard:coverage bundle:audit build]
+
+# Bundler Audit
+
+require 'bundler/audit/task'
+Bundler::Audit::Task.new
+
+# Bundler Gem Build
+
+require 'bundler'
+require 'bundler/gem_tasks'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+CLEAN << 'pkg'
+CLOBBER << 'Gemfile.lock'
+
+# Bump
+
+require 'bump/tasks'
+
+# RSpec
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+CLEAN << 'coverage'
+CLEAN << '.rspec_status'
+CLEAN << 'rspec-report.xml'
+
+# Rubocop
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new do |t|
+  t.options = %w[
+    --format progress
+    --format json --out rubocop-report.json
+  ]
+end
+
+CLEAN << 'rubocop-report.json'
+
+# YARD
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files = %w[lib/**/*.rb examples/**/*]
+  t.stats_options = ['--list-undoc']
+end
+
+CLEAN << '.yardoc'
+CLEAN << 'doc'
+
+# Yardstick
+
+desc 'Run yardstick to show missing YARD doc elements'
+task :'yard:audit' do
+  sh "yardstick 'lib/**/*.rb'"
+end
+
+# Yardstick coverage
+
+require 'yardstick/rake/verify'
+
+Yardstick::Rake::Verify.new(:'yard:coverage') do |verify|
+  verify.threshold = 100
+end
+
+# Additional cleanup
+
+CLEAN << 'tmp'
+CLEAN << 'sig'

data/create_github_release.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative 'lib/create_github_release/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'create_github_release'
+  spec.version = CreateGithubRelease::VERSION
+  spec.authors = ['James']
+  spec.email = ['jcouball@yahoo.com']
+
+  spec.summary = 'Create a GitHub release PR for a Ruby Gem'
+  spec.description = spec.summary
+  spec.homepage = 'https://github.com/main-branch/create_github_release'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = 'exe'
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bump', '~> 0.10'
+  spec.add_development_dependency 'bundler-audit', '~> 0.9'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'redcarpet', '~> 3.5'
+  spec.add_development_dependency 'rspec', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.36'
+  spec.add_development_dependency 'simplecov', '~> 0.21'
+  spec.add_development_dependency 'solargraph', '~> 0.47'
+  spec.add_development_dependency 'yard', '~> 0.9'
+  spec.add_development_dependency 'yardstick', '~> 0.9'
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/exe/create-github-release

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'create_github_release'
+
+options = CreateGithubRelease::CommandLineParser.new.parse(ARGV)
+CreateGithubRelease::ReleaseAssertions.new(options).make_assertions
+puts unless options.quiet
+CreateGithubRelease::ReleaseTasks.new(options).run
+
+puts <<~MESSAGE unless options.quiet
+  Release '#{options.tag}' created successfully
+  See the release notes at #{options.release_url}
+
+  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:
+
+  git checkout #{options.default_branch}
+  git merge --ff-only #{options.branch}
+  git push
+MESSAGE

data/lib/create_github_release/assertion_base.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module CreateGithubRelease
+  # Base class for assertions
+  #
+  # All assertions must inherit from this class.
+  # It holds the options and knows how to print, puts and error while respecting the `quiet` flag.
+  #
+  # @api private
+  #
+  class AssertionBase
+    # Create a new assertion object and save the given `options`
+    # @param options [CreateGithubRelease::Options] the options
+    # @api private
+    def initialize(options)
+      @options = options
+    end
+
+    # This method must be overriden by a subclass
+    #
+    # The subclass is expected to call `error` if the assertion fails.
+    #
+    # @return [void]
+    #
+    # @api private
+    def assert
+      raise NotImplementedError
+    end
+
+    # @!attribute [r] options
+    #
+    # The options passed to the assertion object
+    # @return [CreateGithubRelease::Options] the options
+    # @api private
+    attr_reader :options
+
+    # 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
+    end
+
+    # Calls `Kernel.puts` if the `quiet` flag is not set in the `options`
+    # @param args [Array] the arguments to pass to `Kernel.puts`
+    # @return [void]
+    # @api private
+    def puts(*args)
+      super unless options.quiet
+    end
+
+    # Writes a message to stderr and exits with exitcode 1
+    # @param message [String] the message to write to stderr
+    # @return [void]
+    # @api private
+    def error(message)
+      warn "ERROR: #{message}"
+      exit 1
+    end
+  end
+end

data/lib/create_github_release/assertions/bundle_is_up_to_date.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'create_github_release/assertion_base'
+
+module CreateGithubRelease
+  module Assertions
+    # Assert that options.branch does not exist
+    #
+    # Checks both the local repository and the remote repository.
+    #
+    # @api public
+    #
+    class BundleIsUpToDate < AssertionBase
+      # Make sure the bundle is up to date
+      #
+      # @example
+      #   require 'create_github_release'
+      #
+      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
+      #   assertion = CreateGithubRelease::Assertions::BundleIsUpToDate.new(options)
+      #   begin
+      #     assertion.assert
+      #     puts 'Assertion passed'
+      #   rescue SystemExit
+      #     puts 'Assertion failed'
+      #   end
+      #
+      # @return [void]
+      #
+      # @raise [SystemExit] if the assertion fails
+      #
+      def assert
+        print 'Checking that the bundle is up to date...'
+        if File.exist?('Gemfile.lock')
+          run_bundle_update
+        else
+          run_bundle_install
+        end
+      end
+
+      private
+
+      # Run bundle update
+      # @return [void]
+      # @raise [SystemExit] if bundle update fails
+      # @api private
+      def run_bundle_update
+        print 'Running bundle update...'
+        `bundle update --quiet`
+        if $CHILD_STATUS.success?
+          puts 'OK'
+        else
+          error 'bundle update failed'
+        end
+      end
+
+      # Run bundle install
+      # @return [void]
+      # @raise [SystemExit] if bundle update fails
+      # @api private
+      def run_bundle_install
+        print 'Running bundle install...'
+        `bundle install --quiet`
+        if $CHILD_STATUS.success?
+          puts 'OK'
+        else
+          error 'bundle install failed'
+        end
+      end
+    end
+  end
+end

data/lib/create_github_release/assertions/changelog_docker_container_exists.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'tmpdir'
+require 'create_github_release/assertion_base'
+
+module CreateGithubRelease
+  module Assertions
+    # Assert that the changelog docker container exists
+    #
+    # @api public
+    #
+    class ChangelogDockerContainerExists < AssertionBase
+      # Make sure the changelog docker container exists
+      #
+      # @example
+      #   require 'create_github_release'
+      #
+      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
+      #   assertion = CreateGithubRelease::Assertions::ChangelogDockerContainerExists.new(options)
+      #   begin
+      #     assertion.assert
+      #     puts 'Assertion passed'
+      #   rescue SystemExit
+      #     puts 'Assertion failed'
+      #   end
+      #
+      # @return [void]
+      #
+      # @raise [SystemExit] if the assertion fails
+      #
+      def assert
+        Dir.mktmpdir do |dir|
+          @dir = dir
+          @docker_file = "#{dir}/Dockerfile"
+          File.write(@docker_file, DOCKERFILE)
+          assert_changelog_docker_container_exists
+        end
+      end
+
+      private
+
+      # Create the changelog docker container
+      # @return [void]
+      # @raise [SystemExit] if docker build fails
+      # @api private
+      def assert_changelog_docker_container_exists
+        print 'Checking that the changelog docker container exists (might take time to build)...'
+        `docker build --file "#{@docker_file}" --tag changelog-rs . 1>/dev/null 2>#{@dir}/stderr`
+        if $CHILD_STATUS.success?
+          puts 'OK'
+        else
+          error 'Failed to build the changelog-rs docker container'
+        end
+      end
+
+      DOCKERFILE = <<~CONTENTS
+        FROM rust
+
+        # Build the docker image (from this project's root directory):
+        # docker build --file Dockerfile.changelog-rs --tag changelog-rs .
+        #
+        # Use this image to output a changelog (from this project's root directory):
+        # docker run --rm --volume "$PWD:/worktree" changelog-rs v1.9.1 v1.10.0
+
+        RUN cargo install changelog-rs
+        WORKDIR /worktree
+
+        ENTRYPOINT ["/usr/local/cargo/bin/changelog-rs", "/worktree"]
+      CONTENTS
+    end
+  end
+end

data/lib/create_github_release/assertions/docker_is_running.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'create_github_release/assertion_base'
+
+module CreateGithubRelease
+  module Assertions
+    # Assert that docker is running
+    #
+    # @api public
+    #
+    class DockerIsRunning < AssertionBase
+      # Make sure that docker is running
+      #
+      # @example
+      #   require 'create_github_release'
+      #
+      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
+      #   assertion = CreateGithubRelease::Assertions::DockerIsRunning.new(options)
+      #   begin
+      #     assertion.assert
+      #     puts 'Assertion passed'
+      #   rescue SystemExit
+      #     puts 'Assertion failed'
+      #   end
+      #
+      # @return [void]
+      #
+      # @raise [SystemExit] if the assertion fails
+      #
+      def assert
+        print 'Checking that docker is installed and running...'
+        `docker info > /dev/null 2>&1`
+        if $CHILD_STATUS.success?
+          puts 'OK'
+        else
+          error 'Docker is not installed or not running'
+        end
+      end
+    end
+  end
+end

data/lib/create_github_release/assertions/gh_command_exists.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'create_github_release/assertion_base'
+
+module CreateGithubRelease
+  module Assertions
+    # Assert that the 'gh' command is in the path
+    #
+    # @api public
+    #
+    class GhCommandExists < AssertionBase
+      # Make sure that the 'gh' command is in the path
+      #
+      # @example
+      #   require 'create_github_release'
+      #
+      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
+      #   assertion = CreateGithubRelease::Assertions::GhCommandExists.new(options)
+      #   begin
+      #     assertion.assert
+      #     puts 'Assertion passed'
+      #   rescue SystemExit
+      #     puts 'Assertion failed'
+      #   end
+      #
+      # @return [void]
+      #
+      # @raise [SystemExit] if the assertion fails
+      #
+      def assert
+        print 'Checking that the gh command exists...'
+        `which gh > /dev/null 2>&1`
+        if $CHILD_STATUS.success?
+          puts 'OK'
+        else
+          error 'The gh command was not found'
+        end
+      end
+    end
+  end
+end

data/lib/create_github_release/assertions/git_command_exists.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'create_github_release/assertion_base'
+
+module CreateGithubRelease
+  module Assertions
+    # Assert that the 'git' command is in the path
+    #
+    # @api public
+    #
+    class GitCommandExists < AssertionBase
+      # Make sure that the 'git' command is in the path
+      #
+      # @example
+      #   require 'create_github_release'
+      #
+      #   options = CreateGithubRelease::Options.new { |o| o.release_type = 'major' }
+      #   assertion = CreateGithubRelease::Assertions::GitCommandExists.new(options)
+      #   begin
+      #     assertion.assert
+      #     puts 'Assertion passed'
+      #   rescue SystemExit
+      #     puts 'Assertion failed'
+      #   end
+      #
+      # @return [void]
+      #
+      # @raise [SystemExit] if the assertion fails
+      #
+      def assert
+        print 'Checking that the git command exists...'
+        `which git > /dev/null 2>&1`
+        if $CHILD_STATUS.success?
+          puts 'OK'
+        else
+          error 'The git command was not found'
+        end
+      end
+    end
+  end
+end