runger_release_assistant 0.8.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: acd9c7a3cd90d5c7edece48f080cb2b806186af56aacd4edb18b52b89a0a01c3
-  data.tar.gz: cf080826178149c6a2bd001f3e41907bf6be497fee53b3c718af5a1dcb86146a
+  metadata.gz: 4f602de5188864bef60835e784830100b08349a1719e1d96ccd71a3e76871b3c
+  data.tar.gz: 103c5b3b87636d53f4dc9f8872feee81449e498ded6c190716776c0e007d9918
 SHA512:
-  metadata.gz: 341a2cbea06b39ab4d5d2f45afebc9f457914c0a0b4777d008acb4f2a767f99b2969286811b10ee5efc683062cb36452a212a6407c4f89038c25aa4d279b990c
-  data.tar.gz: 36c969f791d2b3da04a604dbfc68bcb658bf0502e7599fb0fbed4e5c9d5878c45510ae512dac84cef8f25eff70ddb86e735b69aaf9766ef76eab321ead6061db
+  metadata.gz: 70d1914de0407029e273495d797330164fab880f53e113734475410c0bbe82625b318b1b52544eb4ab028443324fe8019ef8653855775aa66a0ae1ba4813d9a6
+  data.tar.gz: b0cbe79c7c6255012d517289c16d14a07a20e24711f6679a8560b17a3c71e8ad1d6c86d1ec57631a15c809ef33ea821ca4f584b500210fc8e9ac2aefe3a2d1b7

data/.github/dependabot.yml

@@ -1,9 +1,12 @@
+---
 version: 2
 updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "04:04"
-    timezone: America/Chicago
-  open-pull-requests-limit: 20
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: daily
+      time: "04:04"
+      timezone: America/Chicago
+    open-pull-requests-limit: 20
+    allow:
+      - dependency-type: all

data/.github/workflows/ruby.yml

@@ -3,13 +3,16 @@ name: Run RuboCop and RSpec
 on:
   pull_request:
     branches:
-    - main
+      - '*'
+  push:
+    branches:
+      - main
 
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - uses: ruby/setup-ruby@v1
       with:
         bundler-cache: true

data/.ruby-version

@@ -1 +1 @@
-3.3.3
+3.3.4

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## v0.10.0 (2024-07-12)
+- Don't require enter key when confirming release
+- Print currently released version when confirming release
+- Print changelog and diff when confirming release
+
+### Internal
+- Bump Ruby from 3.3.3 to 3.3.4
+- Update gems
+- Run Gitleaks, ShellCheck, and RuboCop in pre-push hook
+
+## v0.9.0 (2024-06-28)
+- Enforce only major and minor parts of required Ruby version (loosening the required Ruby version from 3.3.3 to 3.3.0)
+
 ## v0.8.0 (2024-06-15)
 - Rename primary branch from `master` to `main`
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    runger_release_assistant (0.8.0)
+    runger_release_assistant (0.10.0)
       activesupport (>= 6, < 8)
       memo_wise (>= 1.7, < 2)
       rainbow (>= 3.0, < 4)
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (7.1.3.3)
+    activesupport (7.1.3.4)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.0.2)
@@ -25,7 +25,7 @@ GEM
     bigdecimal (3.1.8)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.2.3)
+    concurrent-ruby (1.3.3)
     connection_pool (2.4.1)
     diff-lcs (1.5.1)
     drb (2.2.1)
@@ -33,15 +33,15 @@ GEM
       concurrent-ruby (~> 1.0)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
-    memo_wise (1.8.0)
-    method_source (1.0.0)
-    minitest (5.23.0)
+    memo_wise (1.9.0)
+    method_source (1.1.0)
+    minitest (5.24.1)
     mutex_m (0.2.0)
-    parallel (1.24.0)
-    parser (3.3.1.0)
+    parallel (1.25.1)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
-    prism (0.29.0)
+    prism (0.30.0)
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -52,50 +52,41 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.2.8)
-      strscan (>= 3.0.9)
+    rexml (3.3.1)
+      strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
       rspec-expectations (~> 3.13.0)
       rspec-mocks (~> 3.13.0)
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.0)
+    rspec-expectations (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.0)
+    rspec-mocks (3.13.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-support (3.13.0)
-    rubocop (1.64.0)
+    rspec-support (3.13.1)
+    rubocop (1.65.0)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
+      regexp_parser (>= 2.4, < 3.0)
       rexml (>= 3.2.5, < 4.0)
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
     rubocop-ast (1.31.3)
       parser (>= 3.3.1.0)
-    rubocop-capybara (2.20.0)
-      rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
-      rubocop (~> 1.41)
-    rubocop-performance (1.21.0)
+    rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (2.29.2)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
-      rubocop-rspec_rails (~> 2.28)
-    rubocop-rspec_rails (2.28.3)
-      rubocop (~> 1.40)
+    rubocop-rspec (3.0.3)
+      rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    runger_style (2.4.0)
+    runger_style (2.12.0)
       prism (>= 0.24.0)
       rubocop (>= 1.38.0, < 2)
     slop (4.10.1)
@@ -120,7 +111,7 @@ DEPENDENCIES
   runger_style
 
 RUBY VERSION
-   ruby 3.3.3p89
+   ruby 3.3.4p94
 
 BUNDLED WITH
    2.5.11

data/README.md

@@ -103,7 +103,7 @@ Example:
 
 ## Config
 
-Create a configuration file with `release --init`.
+You can create a configuration file with `release --init`.
 
 Here is an example:
 
@@ -114,6 +114,15 @@ rubygems: false
 primary_branch: main
 ```
 
+The above example (more or less) illustrates the default values, so you don't
+need to create a config file, if those are the values that you want.
+
+Regarding the `primary_branch` option, `runger_release_assistant` will
+automatically detect as the "primary branch" any one of the following: `main`,
+`master`, or `trunk`. So, if one of those is the name of your primary branch,
+and if you also want `git: true` and `rubygems: false`, then you don't need to
+create a config file.
+
 ## Using with RubyGems
 
 By default, `runger_release_assistant` assumes that you only want to "release" your gem via GitHub. If

data/bin/githooks/pre-push

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+set -euo pipefail # exit on any error, don't allow undefined variables, pipes don't swallow errors
+
+lint gitleaks
+
+background-and-notify lint rubocop
+background-and-notify lint shellcheck

data/bin/release

@@ -0,0 +1 @@
+../exe/release

data/lib/runger_release_assistant/config_file_reader.rb

@@ -19,6 +19,7 @@ class RungerReleaseAssistant::ConfigFileReader
     "#{ENV.fetch('PWD')}/.release_assistant.yml"
   end
 
+  memo_wise \
   def config_file_exists?
     File.exist?(config_file_path)
   end

data/lib/runger_release_assistant/version.rb

@@ -2,6 +2,6 @@
 
 # rubocop:disable Style/StaticClass
 class RungerReleaseAssistant
-  VERSION = '0.8.0'
+  VERSION = '0.10.0'
 end
 # rubocop:enable Style/StaticClass

data/lib/runger_release_assistant.rb

@@ -1,12 +1,26 @@
 # frozen_string_literal: true
 
 require 'active_support/all'
+require 'io/console'
 require 'memo_wise'
 require 'rainbow/refinement'
 require 'slop'
 require 'yaml'
 
+module StringWithPipe
+  refine String do
+    def pipe(command)
+      IO.popen(command, 'r+') do |io|
+        io.puts(self)
+        io.close_write
+        io.read
+      end
+    end
+  end
+end
+
 using Rainbow
+using StringWithPipe
 
 # We need to define the class before requiring the modules.
 # rubocop:disable Lint/EmptyClass
@@ -57,8 +71,8 @@ class RungerReleaseAssistant
   end
 
   def run_release
-    print_release_plan
-    confirm_release_plan
+    print_release_info
+    confirm_release_looks_good
     verify_repository_cleanliness
     remember_initial_branch
     switch_to_main
@@ -94,19 +108,29 @@ class RungerReleaseAssistant
     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}")
+  def print_release_info
+    logger.info("You are running the release process with options #{@options.to_h}.")
+    logger.info("Current released version is #{current_released_version.blue}.")
+    logger.info("Current alpha version is #{current_version.yellow}.")
+    logger.info("Next version will be #{next_version.green}.")
+
+    print_changelog_content_of_upcoming_release
+
+    print_diff_since_last_release
   end
 
-  def confirm_release_plan
+  def confirm_release_looks_good
     logger.info('Does that look good? [y]n')
-    response = $stdin.gets.chomp
 
-    if response.downcase == 'n' # rubocop:disable Performance/Casecmp
+    case $stdin.getch
+    when 'n', "\u0003"
       logger.info('Okay, aborting.')
       restore_and_abort(exit_code: 0)
+    when 'y', "\r"
+      # (proceed)
+    else
+      logger.info("That's not an option.")
+      confirm_release_looks_good
     end
   end
 
@@ -130,8 +154,8 @@ class RungerReleaseAssistant
   memo_wise \
   def primary_branch
     @options[:primary_branch] ||
-    common_primary_branch_name ||
-    (raise(UnknownPrimaryBranch))
+      common_primary_branch_name ||
+      (raise(UnknownPrimaryBranch))
   end
 
   memo_wise \
@@ -177,7 +201,11 @@ class RungerReleaseAssistant
   end
 
   def create_tag
-    execute_command(%(git tag -m "Version #{next_version}" v#{next_version}))
+    execute_command(%(git tag -m 'Version #{next_version}' '#{git_tag_version(next_version)}'))
+  end
+
+  def git_tag_version(version)
+    "v#{version}"
   end
 
   def push_to_git
@@ -226,6 +254,23 @@ class RungerReleaseAssistant
     exit(exit_code)
   end
 
+  def print_changelog_content_of_upcoming_release
+    logger.info('Changelog content for this upcoming release:')
+    File.read(changelog_path)[/\A## Unreleased\n(?:(?!\n## ).)+/m].
+      pipe('bat --color always --language markdown --style grid,numbers').
+      then { puts(_1) }
+  end
+
+  def print_diff_since_last_release
+    logger.info('Diff since the last release:')
+    system(
+      { 'DELTA_PAGER' => 'cat' },
+      'git',
+      'diff',
+      "#{git_tag_version(current_released_version)}...",
+    )
+  end
+
   def file_path(file_name)
     system_output("find . -type f -name #{file_name}").delete_prefix('./')
   end
@@ -248,6 +293,11 @@ class RungerReleaseAssistant
     file_path('CHANGELOG.md')
   end
 
+  memo_wise \
+  def current_released_version
+    `git tag -l 'v[0-9]*.[0-9]*.[0-9]*' | sort -V | tail -1`.delete_prefix('v').rstrip
+  end
+
   memo_wise \
   def current_version
     file_contents(version_file_path).match(/VERSION += +['"](?<version>.*)['"]/)&.

data/runger_release_assistant.gemspec

@@ -39,5 +39,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency('rainbow', '>= 3.0', '< 4')
   spec.add_dependency('slop', '~> 4.8')
 
-  spec.required_ruby_version = ">= #{File.read('.ruby-version').rstrip}"
+  required_ruby_version = File.read('.ruby-version').rstrip.sub(/\A(\d+\.\d+)\.\d+\z/, '\1.0')
+  spec.required_ruby_version = ">= #{required_ruby_version}"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runger_release_assistant
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.10.0
 platform: ruby
 authors:
 - David Runger
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-16 00:00:00.000000000 Z
+date: 2024-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,7 +108,9 @@ files:
 - Rakefile
 - bin/_guard-core
 - bin/console
+- bin/githooks/pre-push
 - bin/guard
+- bin/release
 - bin/rspec
 - bin/rubocop
 - bin/setup
@@ -134,14 +136,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.3.3
+      version: 3.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: A gem / CLI tool to automate the release process of other gems