runger_release_assistant 0.9.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b0c99d3dec5f2bdd4c9568d3ce6326371cf08d7f7ddde0f0237f6122fdef768a
-  data.tar.gz: d01f8b764551671d3db86dadc41216aac3c0a89275a25f2b273a327607f88d0f
+  metadata.gz: 64a1650c650f99a77f5b9c36b0656420ec0943a31ce803b6501a83ed3018ed13
+  data.tar.gz: 32780af66bf5a617d190f01044f9e73440b42e5c653ff1e9d9daea94b5c626b2
 SHA512:
-  metadata.gz: 76746bae3f96fee9498b4e31547ca9ca414c2b1f9a957ab45b9075128eddba960f7d12a3506575f2c32416f7b7ae6b4eebb4ba69b601bc384f5805f924d28bcc
-  data.tar.gz: 8d6f05637af0a6dbe3e805b849a46e4c030906f3b0a26e7c234c35fc45907dd257856eae241f52d9ad3f14697eeb7ab6eb2f20054b99c6b4896f4827aa744e95
+  metadata.gz: a59b28167492a89d8d2f42fb89a7a41bbf6b509c41610189a0cfc997814cef46437d3d18723544ab850571be627dd3dc9a7ae98f322e54b44fcd2b253b97b4d6
+  data.tar.gz: 41c32e223762cdfa3caa319d75dec549843b6a19bf7b8dcaa9e8a901b63e0497bfc0d1b76b0a9e5c5144f5e4b353399aaf613b24d91f1a535e34d71b1c1147a1

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/.ruby-version

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

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+## v0.11.0 (2024-07-23)
+- Run 'safe' command (if one exists) after releasing
+
+## 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)
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    runger_release_assistant (0.9.0)
+    runger_release_assistant (0.11.0)
       activesupport (>= 6, < 8)
       memo_wise (>= 1.7, < 2)
       rainbow (>= 3.0, < 4)
@@ -35,10 +35,10 @@ GEM
     language_server-protocol (3.17.0.3)
     memo_wise (1.9.0)
     method_source (1.1.0)
-    minitest (5.24.0)
+    minitest (5.24.1)
     mutex_m (0.2.0)
     parallel (1.25.1)
-    parser (3.3.3.0)
+    parser (3.3.4.0)
       ast (~> 2.4.1)
       racc
     prism (0.30.0)
@@ -52,7 +52,7 @@ GEM
     rainbow (3.1.1)
     rake (13.2.1)
     regexp_parser (2.9.2)
-    rexml (3.3.1)
+    rexml (3.3.2)
       strscan
     rspec (3.13.0)
       rspec-core (~> 3.13.0)
@@ -67,13 +67,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-support (3.13.1)
-    rubocop (1.64.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)
@@ -83,10 +83,10 @@ GEM
     rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (3.0.1)
+    rubocop-rspec (3.0.3)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
-    runger_style (2.8.0)
+    runger_style (2.12.0)
       prism (>= 0.24.0)
       rubocop (>= 1.38.0, < 2)
     slop (4.10.1)
@@ -111,7 +111,7 @@ DEPENDENCIES
   runger_style
 
 RUBY VERSION
-   ruby 3.3.3p89
+   ruby 3.3.4p94
 
 BUNDLED WITH
    2.5.11

data/README.md

@@ -2,27 +2,46 @@
 
 # `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.
+This is a CLI tool that I (David Runger) use to automate the release of new gem
+versions via git/GitHub and (optionally) via RubyGems.
+
+**I do not recommend this gem for general use.**
 
 <!--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 -->
+* [runger_release_assistant](#runger_release_assistant)
+   * [Not recommended for general use!](#not-recommended-for-general-use)
+   * [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)
+   * [Config](#config)
+   * [Using with RubyGems](#using-with-rubygems)
+   * [Development](#development)
+   * [Contributing](#contributing)
+   * [License](#license)
+
+<!-- Created by https://github.com/ekalinin/github-markdown-toc -->
+<!-- Added by: david, at: Tue Jul 23 12:46:01 AM CDT 2024 -->
 
 <!--te-->
 
+## Not recommended for general use!
+
+This gem is somewhat customized and built specifically for my (David Runger's)
+custom and idiosyncratic workflow. For example, after releasing, this gem will
+automatically execute a `safe` command, if one is present on the machine. You
+might not want this behavior (if you have a `safe` command that you _don't_ want
+to be invoked after a release).
+
+Realistically speaking, though, this gem actually probably could be used by
+anyone, since most of this gem's functionality actually is built in a
+generalized way that I think won't conflict with most other people's workflows,
+but, still, I'm guessing that there are other, better tools available, anyway,
+and, so, on net, I just wouldn't recommend that others use this gem.
+
 ## Dependencies
 
 This gem assumes that you have `git` installed.

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/lib/runger_release_assistant/version.rb

@@ -2,6 +2,6 @@
 
 # rubocop:disable Style/StaticClass
 class RungerReleaseAssistant
-  VERSION = '0.9.0'
+  VERSION = '0.11.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
@@ -83,6 +97,7 @@ class RungerReleaseAssistant
     ERROR_LOG
     restore_and_abort(exit_code: 1)
   else
+    run_safe_command
     switch_to_initial_branch
   end
 
@@ -94,19 +109,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
 
@@ -177,7 +202,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
@@ -192,6 +221,12 @@ class RungerReleaseAssistant
     execute_command('bundle exec rake release', show_system_output: true)
   end
 
+  def run_safe_command
+    if system('which safe')
+      execute_command('safe')
+    end
+  end
+
   def switch_to_initial_branch
     execute_command("git checkout #{@initial_branch}") if @initial_branch
   end
@@ -226,6 +261,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 +300,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>.*)['"]/)&.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: runger_release_assistant
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.11.0
 platform: ruby
 authors:
 - David Runger
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-29 00:00:00.000000000 Z
+date: 2024-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -108,6 +108,7 @@ files:
 - Rakefile
 - bin/_guard-core
 - bin/console
+- bin/githooks/pre-push
 - bin/guard
 - bin/release
 - bin/rspec
@@ -142,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.14
+rubygems_version: 3.5.15
 signing_key:
 specification_version: 4
 summary: A gem / CLI tool to automate the release process of other gems