runger_release_assistant 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 011ae97cdb5d94a3869c9066f6b442ef2d8e3a35b8a7ac2a6dda48bc14e74f51
+  data.tar.gz: b4179c8221b31016309bda9dc639d4b24375034341cebd0a7eb9bc88c29911ac
+SHA512:
+  metadata.gz: 461e0fd47ffe206205a971337814d01e17837dea09dd346b6c4660972587d0f9205fd216cf179649ada29e41381e6edf7bac576c4395ac2954159ff0a99bbead
+  data.tar.gz: e74ae3e589d360c2478b74325f1133ee521def6129b1b5e2ece65bc1030e4aed2497fe80120a3afbb581d93264e23ea39bbcf7f2e0c6e06218c3ed50e42c5fbb

data/.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+    time: "03:52"
+    timezone: America/Chicago
+  open-pull-requests-limit: 20

data/.github/workflows/ruby.yml

@@ -0,0 +1,23 @@
+name: Run Rspec Tests
+
+on:
+  pull_request:
+    branches:
+    - master
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true
+    - name: Run Rubocop
+      run: bin/rubocop --format clang
+    - name: Run RSpec tests
+      run: bin/rspec --format progress
+    - name: Ensure alpha version
+      run: grep alpha lib/runger_release_assistant/version.rb
+    - name: Ensure no git diff
+      run: git diff --exit-code

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.release_assistant.yml

@@ -0,0 +1,3 @@
+---
+git: true
+rubygems: true

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,5 @@
+inherit_gem:
+  runger_style:
+    - rulesets/default.yml # gem 'rubocop'
+    - rulesets/performance.yml # gem 'rubocop-performance'
+    - rulesets/rspec.yml # gem 'rubocop-rspec'

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/CHANGELOG.md

@@ -0,0 +1,57 @@
+## v0.4.0 (2023-05-22)
+### Added
+- Release via RubyGems
+
+### Changed
+- Rename with "Runger" prefix
+  - For backwards compatibility, the (optional) config file will still be called
+    `.release_assistant.yml` (not `.runger_release_assistant.yml`)
+
+## v0.3.2 (2021-02-05)
+### Changed
+- Bump Ruby version from 2.7.2 to 3.0.0
+
+## v0.3.1 (2021-02-01)
+### Fixed
+- Release the correct (non-alpha) gem verision to RubyGems
+
+### Changed
+- Validate when initializing `RungerReleaseAssistant` that options are valid (which currently entails only
+  checking for `git: true`)
+- Always show system output for the release phase when pushing to RubyGems (if pushing to RubyGems)
+  in order to allow for engaging with the RubyGems 2FA prompt (which should be enabled)
+
+## v0.3.0 (2021-02-01)
+### Added
+- Allow for managing releases via RubyGems (in addition to GitHub)
+- Add `--show-system-output` option to show outpup of executed system commands. (By default, the
+  output of executed system commands will be suppressed.)
+
+## v0.2.0 (2021-01-28)
+### Changed
+- Leave version numbers unchanged if bumping from version w/ modifier (e.g. `2.0.0.alpha` to `2.0.0`
+  or `0.4.0.alpha` to `0.4.0`)
+
+## v0.1.0 (2021-01-26)
+### Added
+- Bump to next alpha version after creating release
+
+## v0.0.3 (2021-01-26)
+- Ensure in PR CI runs that the current version contains "alpha" & that there's no git diff (e.g.
+  due to failing to run `bundle` after updating the version)
+
+## v0.0.2 (2021-01-26)
+### Fixed
+- Push git tags when releasing
+
+## v0.0.1 (2021-01-26)
+### Added
+- Create `runger_release_assistant` tool to aid with releasing/publishing gems (particularly via GitHub)
+- Require confirmation before releasing
+- Restore original state (current git branch, file contents) when aborting
+
+### Fixed
+- Read confirmation from `STDIN`
+
+### Removed
+- Remove lingering code/documentation related to `.release_assistant.yml` config file

data/Gemfile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+ruby '3.2.0'
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in runger_release_assistant.gemspec
+gemspec
+
+group :development, :test do
+  gem 'bundler', require: false
+  gem 'pry'
+  gem 'pry-byebug'
+  gem 'rake', require: false
+  gem 'rspec', require: false
+  gem 'rubocop', require: false
+  gem 'rubocop-performance', require: false
+  gem 'rubocop-rspec', require: false
+  gem 'runger_style', require: false
+end

data/Gemfile.lock

@@ -0,0 +1,106 @@
+PATH
+  remote: .
+  specs:
+    runger_release_assistant (0.4.0)
+      activesupport (>= 6, < 8)
+      colorize (~> 0.8)
+      memoist (~> 0.16)
+      slop (~> 4.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.0.4.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    colorize (0.8.1)
+    concurrent-ruby (1.2.2)
+    diff-lcs (1.5.0)
+    i18n (1.13.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    memoist (0.16.2)
+    method_source (1.0.0)
+    minitest (5.18.0)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.10.1)
+      byebug (~> 11.0)
+      pry (>= 0.13, < 0.15)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.51.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.1)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-factory_bot (2.22.0)
+      rubocop (~> 1.33)
+    rubocop-performance (1.18.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.22.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+    ruby-progressbar (1.13.0)
+    runger_style (0.2.22)
+      rubocop (>= 1.38.0, < 2)
+    slop (4.10.1)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  pry
+  pry-byebug
+  rake
+  rspec
+  rubocop
+  rubocop-performance
+  rubocop-rspec
+  runger_release_assistant!
+  runger_style
+
+RUBY VERSION
+   ruby 3.2.0p0
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 David Runger
+
+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,140 @@
+![GitHub tag (latest SemVer pre-release)](https://img.shields.io/github/v/tag/davidrunger/runger_release_assistant?include_prereleases)
+
+# `runger_release_assistant`
+
+This is a CLI tool that helps to automate the process of releasing new versions of a gem via
+git/GitHub and (optionally) via RubyGems.
+
+<!--ts-->
+   * [runger_release_assistant](#runger_release_assistant)
+      * [Dependencies](#dependencies)
+      * [Installation](#installation)
+         * [Global installation](#global-installation)
+         * [Installation in a specific project](#installation-in-a-specific-project)
+            * [Create a binstub](#create-a-binstub)
+      * [Basic usage](#basic-usage)
+         * [Available options and examples](#available-options-and-examples)
+      * [Using with RubyGems](#using-with-rubygems)
+      * [Development](#development)
+      * [Contributing](#contributing)
+      * [License](#license)
+
+<!-- Added by: david, at: Mon Feb  1 20:16:03 PST 2021 -->
+
+<!--te-->
+
+## Dependencies
+
+This gem assumes that you have `git` installed.
+
+## Installation
+
+### Global installation
+
+```
+gem install runger_release_assistant
+```
+
+Then you can execute `release` anywhere on your machine.
+
+### Installation in a specific project
+
+Add `runger_release_assistant` to your `Gemfile`:
+
+```rb
+group :development do
+  gem 'runger_release_assistant', require: false
+end
+```
+
+Then, you can execute `bundle exec release`.
+
+#### Create a binstub
+
+When using bundler, you can create a binstub via:
+
+```
+bundle binstubs runger_release_assistant
+```
+
+Then, you can execute `bin/release`.
+
+## Basic usage
+
+If installed globally:
+
+```
+$ release [options]
+```
+
+If installed via bundler without a binstub:
+
+```
+$ bundle exec release [options]
+```
+
+If installed via bundler with a binstub:
+
+```
+$ bin/release [options]
+```
+
+### Available options and examples
+
+After installing, execute `release --help` to see usage examples and available options.
+
+```
+$ release --help
+
+Usage: release [options]
+
+Example:
+  release
+  release --type minor
+  release -t patch
+
+    -t, --type                Release type (major, minor, or patch)
+    -d, --debug               print debugging info
+    -s, --show-system-output  show system output
+    -i, --init                create a `.release_assistant.yml` config file
+    -v, --version             print the version
+    -h, --help                print this help information
+```
+
+## Config
+
+Create a configuration file with `release --init`.
+
+Here is an example:
+
+```yml
+---
+git: true
+rubygems: false
+primary_branch: main
+```
+
+## Using with RubyGems
+
+By default, `runger_release_assistant` assumes that you only want to "release" your gem via GitHub. If
+you'd also like to release the gem via RubyGems, then create a `.release_assistant.yml` file by
+executing `release --init`. Within that file, modify the default `rubygems: false` option to
+`rubygems: true`.
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/davidrunger/runger_release_assistant.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).

data/RELEASING.md

@@ -0,0 +1,5 @@
+To release a new version, run `exe/release` with an appropriate `--type` option, e.g.:
+
+```
+exe/release --type minor
+```

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task(default: :spec)

data/bin/_guard-core

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application '_guard-core' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', '_guard-core')

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'runger_release_assistant'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/guard

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/rspec

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/bin/rubocop

@@ -0,0 +1,28 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+#
+# This file was generated by Bundler.
+#
+# The application 'rubocop' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', Pathname.new(__FILE__).realpath)
+
+bundle_binstub = File.expand_path('bundle', __dir__)
+
+if File.file?(bundle_binstub)
+  if File.read(bundle_binstub, 300).include?('This file was generated by Bundler')
+    load(bundle_binstub)
+  else
+    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
+Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
+  end
+end
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rubocop', 'rubocop')

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/release

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'slop'
+require_relative '../lib/runger_release_assistant.rb'
+
+slop_options =
+  Slop.parse do |o|
+    o.banner = <<~BANNER
+
+      Usage: release [options]
+
+      Example:
+        release
+        release --type minor
+        release -t patch
+    BANNER
+
+    RungerReleaseAssistant.define_slop_options(o)
+
+    o.on('-i', '--init', 'create a `.release_assistant.yml` config file') do
+      File.write(
+        '.release_assistant.yml',
+        YAML.dump(RungerReleaseAssistant::DEFAULT_OPTIONS.stringify_keys),
+      )
+      puts("Created #{'.release_assistant.yml'.green.bold}!")
+      exit
+    end
+
+    o.on('-v', '--version', 'print the version') do
+      puts(RungerReleaseAssistant::VERSION)
+      exit
+    end
+
+    o.on('-h', '--help', 'print this help information') do
+      puts(o)
+      exit
+    end
+  end
+
+config_file_options = RungerReleaseAssistant::ConfigFileReader.new.options_hash
+
+RungerReleaseAssistant.new(
+  RungerReleaseAssistant::DEFAULT_OPTIONS.
+    merge(config_file_options).
+    merge(slop_options.to_h),
+).run_release

data/lib/runger_release_assistant/config_file_reader.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+class RungerReleaseAssistant::ConfigFileReader
+  extend Memoist
+
+  memoize \
+  def options_hash
+    if config_file_exists?
+      YAML.load_file(config_file_path).symbolize_keys
+    else
+      {}
+    end
+  end
+
+  private
+
+  memoize \
+  def config_file_path
+    "#{ENV.fetch('PWD')}/.release_assistant.yml"
+  end
+
+  def config_file_exists?
+    File.exist?(config_file_path)
+  end
+end

data/lib/runger_release_assistant/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+# rubocop:disable Style/StaticClass
+class RungerReleaseAssistant
+  VERSION = '0.4.0'
+end
+# rubocop:enable Style/StaticClass

data/lib/runger_release_assistant/version_calculator.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+class RungerReleaseAssistant::VersionCalculator
+  extend Memoist
+
+  def initialize(current_version:)
+    @current_version = current_version
+  end
+
+  # rubocop:disable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+  def increment_for(type)
+    new_parts =
+      case type
+      when 'major'
+        if modifier.present? && (minor == 0) && (patch == 0)
+          # e.g. going from `2.0.0.alpha` to `2.0.0`
+          [major, minor, patch]
+        else
+          # e.g. going from `2.3.4` to `3.0.0`
+          [major + 1, 0, 0]
+        end
+      when 'minor'
+        if modifier.present? && (patch == 0)
+          # e.g. going from `0.4.0.alpha` to `0.4.0`
+          [major, minor, patch]
+        else
+          # e.g. going from `0.3.3` to `0.4.0`
+          [major, minor + 1, 0]
+        end
+      when 'patch'
+        if modifier.present?
+          # e.g. going from `0.3.3.alpha` to `0.3.3`
+          [major, minor, patch]
+        else
+          # e.g. going from `0.3.3` to `0.3.4`
+          [major, minor, patch + 1]
+        end
+      end
+    new_parts.map(&:to_s).join('.')
+  end
+  # rubocop:enable Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity
+
+  private
+
+  memoize \
+  def modifier
+    @current_version.split('.')[3]
+  end
+
+  memoize \
+  def parts
+    @current_version.split('.').first(3).map { Integer(_1) }
+  end
+
+  memoize \
+  def major
+    parts[0]
+  end
+
+  memoize \
+  def minor
+    parts[1]
+  end
+
+  memoize \
+  def patch
+    parts[2]
+  end
+end

data/lib/runger_release_assistant.rb

@@ -0,0 +1,256 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+require 'colorize'
+require 'memoist'
+require 'slop'
+require 'yaml'
+
+# We need to define the class before requiring the modules.
+# rubocop:disable Lint/EmptyClass
+class RungerReleaseAssistant
+end
+# rubocop:enable Lint/EmptyClass
+
+Dir["#{File.dirname(__FILE__)}/runger_release_assistant/**/*.rb"].each { |file| require file }
+
+class RungerReleaseAssistant
+  extend Memoist
+
+  DEFAULT_OPTIONS = { git: true, rubygems: false }.freeze
+
+  class << self
+    def define_slop_options(options)
+      options.string('-t', '--type', 'Release type (major, minor, or patch)', default: 'patch')
+      options.bool('-d', '--debug', 'print debugging info', default: false)
+      options.bool('-s', '--show-system-output', 'show system output', default: false)
+    end
+  end
+
+  def initialize(options)
+    @options = options
+    validate_options!
+    logger.debug("Running release with options #{@options}")
+  end
+
+  memoize \
+  def logger
+    Logger.new($stdout).tap do |logger|
+      logger.formatter =
+        ->(_severity, _datetime, _progname, msg) {
+          "[runger_release_assistant] #{msg}\n"
+        }
+      logger.level = @options[:debug] ? Logger::DEBUG : Logger::INFO
+    end
+  end
+
+  def run_release
+    print_release_plan
+    confirm_release_plan
+    verify_repository_cleanliness
+    remember_initial_branch
+    switch_to_main
+
+    update_changelog_for_release
+    update_version_file(next_version)
+    bundle_install
+    commit_changes(message: "Prepare to release v#{next_version}")
+    create_tag
+    push_to_rubygems_and_git if @options[:rubygems] && @options[:git]
+
+    update_changelog_for_alpha
+    update_version_file(alpha_version_after_next_version)
+    bundle_install
+    commit_changes(message: "Bump to v#{alpha_version_after_next_version}")
+    push_to_git if @options[:git]
+  rescue => error
+    logger.error(<<~ERROR_LOG)
+      \n
+      #{error.class.name.red}: #{error.message.red}
+      #{error.backtrace.join("\n")}
+    ERROR_LOG
+    restore_and_abort(exit_code: 1)
+  else
+    switch_to_initial_branch
+  end
+
+  private
+
+  def validate_options!
+    if @options[:git] != true
+      fail('The `git` configuration option must be `true`')
+    end
+  end
+
+  def print_release_plan
+    logger.info("You are running the release process with options #{@options.to_h}!")
+    logger.info("Current version is #{current_version}")
+    logger.info("Next version will be #{next_version}")
+  end
+
+  def confirm_release_plan
+    logger.info('Does that look good? [y]n')
+    response = $stdin.gets.chomp
+
+    if response.downcase == 'n' # rubocop:disable Performance/Casecmp
+      logger.info('Okay, aborting.')
+      restore_and_abort(exit_code: 0)
+    end
+  end
+
+  def verify_repository_cleanliness
+    fail 'There are unstaged changes!' if !system('git diff --exit-code')
+    fail 'There are staged changes!' if !system('git diff-index --quiet --cached HEAD')
+  end
+
+  def remember_initial_branch
+    @initial_branch = current_branch
+  end
+
+  def current_branch
+    system_output('git branch --show-current')
+  end
+
+  def switch_to_main
+    execute_command("git checkout #{main_branch}")
+  end
+
+  memoize \
+  def main_branch
+    @options[:primary_branch] || 'master'
+  end
+
+  def update_changelog_for_release
+    old_changelog_content = file_contents(changelog_path)
+    new_changelog_content =
+      old_changelog_content.
+        gsub(
+          /(#+) Unreleased/,
+          "\\1 v#{next_version} (#{Date.current.iso8601})",
+        )
+    write_file(changelog_path, new_changelog_content)
+  end
+
+  def update_changelog_for_alpha
+    old_changelog_content = file_contents(changelog_path)
+    write_file(changelog_path, <<~NEW_CHANGELOG_CONTENT)
+      ## Unreleased
+      [no unreleased changes yet]
+
+      #{old_changelog_content.rstrip}
+    NEW_CHANGELOG_CONTENT
+  end
+
+  def update_version_file(new_version)
+    old_version_file_content = file_contents(version_file_path)
+    new_version_file_content =
+      old_version_file_content.gsub(/(VERSION += +['"]).*(['"])/, "\\1#{new_version}\\2")
+    write_file(version_file_path, new_version_file_content)
+  end
+
+  def bundle_install
+    execute_command('bundle install')
+  end
+
+  def commit_changes(message:)
+    execute_command("git add CHANGELOG.md Gemfile.lock #{version_file_path}")
+    execute_command("git commit -m '#{message}'")
+  end
+
+  def create_tag
+    execute_command(%(git tag -m "Version #{next_version}" v#{next_version}))
+  end
+
+  def push_to_git
+    logger.debug('Pushing to git remote')
+    execute_command('git push')
+    execute_command('git push --tags')
+  end
+
+  def push_to_rubygems_and_git
+    logger.debug('Pushing to RubyGems and git')
+    # Always show system output because 2FA should be enabled, which requires user to see the prompt
+    execute_command('bundle exec rake release', show_system_output: true)
+  end
+
+  def switch_to_initial_branch
+    execute_command("git checkout #{@initial_branch}") if @initial_branch
+  end
+
+  def system_output(command)
+    `#{command}`.rstrip
+  end
+
+  def execute_command(command, raise_error: true, show_system_output: false)
+    logger.debug("Running system command `#{command}`")
+    if @options[:show_system_output] || show_system_output
+      system(command, exception: raise_error)
+    else
+      system(command, exception: raise_error, out: File::NULL, err: File::NULL)
+    end
+  end
+
+  def restore_and_abort(exit_code:)
+    if current_branch == main_branch
+      execute_command("git reset --hard origin/#{main_branch}")
+    end
+
+    if execute_command("git rev-parse v#{next_version}", raise_error: false)
+      execute_command("git tag -d v#{next_version}")
+    end
+
+    if !execute_command('git diff --exit-code', raise_error: false)
+      execute_command("git checkout Gemfile.lock #{changelog_path} #{version_file_path}")
+    end
+
+    switch_to_initial_branch
+    exit(exit_code)
+  end
+
+  def file_path(file_name)
+    system_output("find . -type f -name #{file_name}").delete_prefix('./')
+  end
+
+  def file_contents(file_path)
+    File.read("#{ENV.fetch('PWD')}/#{file_path}")
+  end
+
+  def write_file(file_path, file_contents)
+    File.write("#{ENV.fetch('PWD')}/#{file_path}", file_contents)
+  end
+
+  memoize \
+  def version_file_path
+    file_path('version.rb')
+  end
+
+  memoize \
+  def changelog_path
+    file_path('CHANGELOG.md')
+  end
+
+  memoize \
+  def current_version
+    file_contents(version_file_path).match(/VERSION += +['"](?<version>.*)['"]/)&.
+      named_captures&.to_h&.
+      dig('version')
+  end
+
+  memoize \
+  def next_version
+    version_calculator.increment_for(@options[:type])
+  end
+
+  def alpha_version_after_next_version
+    next_patch_version =
+      RungerReleaseAssistant::VersionCalculator.new(
+        current_version: next_version,
+      ).increment_for('patch')
+    "#{next_patch_version}.alpha"
+  end
+
+  memoize \
+  def version_calculator
+    RungerReleaseAssistant::VersionCalculator.new(current_version:)
+  end
+end

data/runger_release_assistant.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'runger_release_assistant/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'runger_release_assistant'
+  spec.version       = RungerReleaseAssistant::VERSION
+  spec.authors       = ['David Runger']
+  spec.email         = ['davidjrunger@gmail.com']
+
+  spec.summary       = 'CLI tool for parsing git history'
+  spec.homepage      = 'https://github.com/davidrunger/runger_release_assistant'
+  spec.license       = 'MIT'
+
+  if spec.respond_to?(:metadata)
+    spec.metadata['rubygems_mfa_required'] = 'true'
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/davidrunger/runger_release_assistant'
+    spec.metadata['changelog_uri'] =
+      'https://github.com/davidrunger/runger_release_assistant/blob/master/CHANGELOG.md'
+  else
+    raise('RubyGems 2.0 or newer is required to protect against public gem pushes.')
+  end
+
+  # 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(File.expand_path(__dir__)) do
+      `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency('activesupport', '>= 6', '< 8')
+  spec.add_dependency('colorize', '~> 0.8')
+  spec.add_dependency('memoist', '~> 0.16')
+  spec.add_dependency('slop', '~> 4.8')
+
+  spec.required_ruby_version = '>= 3.2'
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: runger_release_assistant
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- David Runger
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '6'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: memoist
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.8'
+description:
+email:
+- davidjrunger@gmail.com
+executables:
+- release
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/dependabot.yml"
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".release_assistant.yml"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- RELEASING.md
+- Rakefile
+- bin/_guard-core
+- bin/console
+- bin/guard
+- bin/rspec
+- bin/rubocop
+- bin/setup
+- exe/release
+- lib/runger_release_assistant.rb
+- lib/runger_release_assistant/config_file_reader.rb
+- lib/runger_release_assistant/version.rb
+- lib/runger_release_assistant/version_calculator.rb
+- runger_release_assistant.gemspec
+homepage: https://github.com/davidrunger/runger_release_assistant
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+  homepage_uri: https://github.com/davidrunger/runger_release_assistant
+  source_code_uri: https://github.com/davidrunger/runger_release_assistant
+  changelog_uri: https://github.com/davidrunger/runger_release_assistant/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.13
+signing_key:
+specification_version: 4
+summary: CLI tool for parsing git history
+test_files: []