runger_release_assistant 3.2.0 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5aab9f2fb1ddc54a55bbf183b140203ad9f100acce5f283c9490ef31869ff3ad
-  data.tar.gz: 79cce0892a612bbb04db2496fbdd8c037ea880904fbc7cfe4c4e8e2cbf18f1b9
+  metadata.gz: 5ad2c73ce4962b251c902dbe5bdb69f65cd30efc604fa9de98ac16be34a964a9
+  data.tar.gz: ab3f19726d8156a7a16443e9898229c77a75a5b6a228d1a87ef8ae90c1b28d05
 SHA512:
-  metadata.gz: e4941b764bb3f1874b2ce9c0dcaa34be27b4271dc560143fd27ec5f484e85b060dea6a02496ae407f063c028f9d399bd323d5a682e4585924291f7aa8070dc62
-  data.tar.gz: f92c6e90bd2b1822c5a679661eb28ef7d432c7180dbca8e600fdc080b51e752ec10746c5aae42449a9fb52df97521e1fce3cf286e65f9644f11e1b8f0e6c41fb
+  metadata.gz: 84899c866e3fa6935233cdca4ac0f2dea0e032160b10091830d50efb0f9e4ada98c2edc3bebf70236b2280638e2867879b15183786a094b3f0a2a6a807435656
+  data.tar.gz: d6193ba1d6e26f48e3d13dd09c8f884b1bbf89397bc207e22ef7a4ad477b3818607bddee70f57d115fae36354770e30b4e8a43280ad3c3d972a9a000de8b9ec2

data/.release_assistant.yml

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

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## Unreleased
 [no unreleased changes yet]
 
+## v4.1.0 (2025-03-20)
+- Support optional tag prefix (via a `tag_prefix` in `.release_assistant.yml`).
+
+## v4.0.0 (2025-03-20)
+- **BREAKING:** Always push to git, rather than requiring `git: true` to be specified in the config (or respecting at all a `git` option in the config).
+
 ## v3.2.0 (2025-03-20)
 - Add `-a` flag to `git tag` command to be clear that the tag is annotated.
 
@@ -11,7 +17,7 @@
 - Actually push to git even if RubyGems is also enabled.
 
 ## v3.0.0 (2025-03-20)
-- Stop creating a new alpha version after release.
+- **BREAKING:** Stop creating a new alpha version after release.
 - Push to git even if pushing to RubyGems is not enabled.
 
 ## v2.0.1 (2025-03-19)

data/Gemfile.lock

@@ -9,7 +9,7 @@ GIT
 PATH
   remote: .
   specs:
-    runger_release_assistant (3.2.0)
+    runger_release_assistant (4.1.0)
       activesupport (>= 6)
       memo_wise (>= 1.7)
       rainbow (>= 3.0)
@@ -190,7 +190,7 @@ CHECKSUMS
   rubocop-rspec (3.5.0) sha256=710c942fe1af884ba8eea75cbb8bdbb051929a2208880a6fc2e2dce1eed5304c
   ruby-progressbar (1.13.0) sha256=80fc9c47a9b640d6834e0dc7b3c94c9df37f08cb072b7761e4a71e22cff29b33
   runger_byebug (11.4.0) sha256=569e22ba2215f57e7f69e145fcb63be401e29fcd312f7936d813e12d0c7bbee6
-  runger_release_assistant (3.2.0)
+  runger_release_assistant (4.1.0)
   runger_style (5.7.0) sha256=200790f3998e0b924df17efc9d440ddec99508bae983ba2a63f42b80624762f0
   securerandom (0.4.1) sha256=cc5193d414a4341b6e225f0cb4446aceca8e50d5e1888743fac16987638ea0b1
   slop (4.10.1) sha256=844322b5ffcf17ed4815fdb173b04a20dd82b4fd93e3744c88c8fafea696d9c7

data/README.md

@@ -112,7 +112,6 @@ Here is an example:
 
 ```yml
 ---
-git: true
 rubygems: false
 primary_branch: main
 ```
@@ -120,11 +119,7 @@ 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.
+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 `rubygems: false`, then you don't need to create a config file.
 
 ## Post-release command
 
@@ -137,6 +132,16 @@ you'd also like to release the gem via RubyGems, then create a `.release_assista
 executing `release --init`. Within that file, modify the default `rubygems: false` option to
 `rubygems: true`.
 
+## Tag prefix
+
+By default, Git tags are created like `v1.0.0`. If you would like to prefix the git tag with any additional content, you may specify a `tag_prefix` in `.release_assistant.yml`, such as:
+
+```yml
+tag_prefix: gem/
+```
+
+This example would generate tags in the form `gem/v1.0.0`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run

data/lib/runger_release_assistant/version.rb

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

data/lib/runger_release_assistant.rb

@@ -43,7 +43,7 @@ class RungerReleaseAssistant
     end
   end
 
-  DEFAULT_OPTIONS = { git: true, rubygems: false }.freeze
+  DEFAULT_OPTIONS = { rubygems: false }.freeze
 
   class << self
     def define_slop_options(options)
@@ -53,9 +53,8 @@ class RungerReleaseAssistant
     end
   end
 
-  def initialize(options)
+  def initialize(options = {}) # rubocop:disable Style/OptionHash
     @options = options
-    validate_options!
     logger.debug("Running release with options #{@options}")
   end
 
@@ -95,12 +94,6 @@ class RungerReleaseAssistant
 
   private
 
-  def validate_options!
-    if @options[:git] != true
-      fail('The `git` configuration option must be `true`')
-    end
-  end
-
   def ensure_on_main_branch
     if current_branch != primary_branch
       fail('You must be on the primary branch to release!')
@@ -187,11 +180,11 @@ class RungerReleaseAssistant
   end
 
   def create_tag
-    execute_command(%(git tag -a '#{git_tag_version(next_version)}' -m 'Version #{next_version}'))
+    execute_command(%(git tag -a '#{git_tag(next_version)}' -m 'Version #{next_version}'))
   end
 
-  def git_tag_version(version)
-    "v#{version}"
+  def git_tag(version)
+    "#{@options[:tag_prefix]}v#{version}"
   end
 
   def push_to_rubygems_and_or_git
@@ -199,15 +192,7 @@ class RungerReleaseAssistant
       push_to_rubygems
     end
 
-    if @options[:git]
-      push_to_git
-    end
-  end
-
-  def push_to_git
-    logger.debug('Pushing to git remote')
-    execute_command('git push')
-    execute_command('git push --tags')
+    push_to_git
   end
 
   def push_to_rubygems
@@ -216,6 +201,12 @@ class RungerReleaseAssistant
     execute_command('bundle exec rake release', show_system_output: true)
   end
 
+  def push_to_git
+    logger.debug('Pushing to git remote')
+    execute_command('git push')
+    execute_command('git push --tags')
+  end
+
   def run_post_release_command
     post_release_command_query_command =
       'runger-config --directory ~/code/dotfiles post-release-command'
@@ -284,7 +275,7 @@ class RungerReleaseAssistant
       { 'DELTA_PAGER' => 'cat' },
       'git',
       'diff',
-      "#{git_tag_version(current_released_version)}...",
+      "#{latest_tag}...",
     )
   end
 
@@ -310,9 +301,14 @@ class RungerReleaseAssistant
     file_path('CHANGELOG.md')
   end
 
+  memo_wise \
+  def latest_tag
+    `git tag -l 'v[0-9]*.[0-9]*.[0-9]*' | sort -V | tail -1`.rstrip
+  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
+    latest_tag.match(/v(\d.*)$/)&.[](1)
   end
 
   memo_wise \

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: runger_release_assistant
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 4.1.0
 platform: ruby
 authors:
 - David Runger