kettle-dev 1.1.36 → 1.1.37

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b545b3e57dcdffa09b3195b7791e53fa5856a30a14ceef4038b3720a743c9f87
-  data.tar.gz: 2b123d25738a5c95b878a45a6aecf727f88c8f76f39c30de267007500480c31c
+  metadata.gz: c9fad405b0585e4d0a4f5651683dca26a005520d41b8a17ffa36cc9ab41cdd45
+  data.tar.gz: c02e4989597f4b2635daf24215d608b3855c7223799acc2049fe26de47f5ab37
 SHA512:
-  metadata.gz: 5aef7adb48e8d7ee2fe92cb767ed6cbc19afbbe7b39da1007d587914f51db177ab5a944c8818a2facf708368234a442099e873d057ad08941508f0fb210621cf
-  data.tar.gz: 615ca36572d9d41c37bc3f890f5269775ac34856bee5cb27f1b9fec0fcb66e9056da3a2e3072936d732ae8f97fa7fcfc9ec6195efd6afa77c9303886c7060690
+  metadata.gz: b7d4aad2935288d5e4a5c79613453c075c1b1896fc45b7a02db73f50c6fa7016f90a7d821720ec051962644d0b5b6a86dd85ed3c7b66541e5779ccfbbcd45766
+  data.tar.gz: 0de641cbe2fdf22fb4441dc7e92cf6deba7be4ac7fa31e35a3592afdcef6df76780ecd10c8ed0796de6a446c05bf15ca96ca4332ea0050dc2038c56b6b6d090e

data/.gitignore

@@ -4,6 +4,7 @@
 *.gem
 
 # Bundler
+/vendor/bundle/
 /.bundle/
 /gemfiles/*.lock
 /gemfiles/.bundle/

data/CHANGELOG.md

@@ -20,8 +20,14 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Added
 
+- kettle-release: improved --help
+- improved documentation of kettle-release
+- improved documentation of spec setup with kettle-test
+
 ### Changed
 
+- upgrade to kettle-test v1.0.6
+
 ### Deprecated
 
 ### Removed
@@ -30,6 +36,23 @@ Please file a bug if you notice a violation of semantic versioning.
 
 ### Security
 
+## [1.1.37] - 2025-10-21
+
+- TAG: [v1.1.37][1.1.37t]
+- COVERAGE: 96.04% -- 3949/4112 lines in 26 files
+- BRANCH COVERAGE: 80.80% -- 1633/2021 branches in 26 files
+- 79.68% documented
+
+### Added
+
+- kettle-release: improved --help
+- improved documentation of kettle-release
+- improved documentation of spec setup with kettle-test
+
+### Changed
+
+- upgrade to kettle-test v1.0.6
+
 ## [1.1.36] - 2025-10-20
 
 - TAG: [v1.1.36][1.1.36t]
@@ -1134,7 +1157,9 @@ Please file a bug if you notice a violation of semantic versioning.
   - Selecting will run the selected workflow via `act`
   - This may move to its own gem in the future.
 
-[Unreleased]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.36...HEAD
+[Unreleased]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.37...HEAD
+[1.1.37]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.36...v1.1.37
+[1.1.37t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.1.37
 [1.1.36]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.35...v1.1.36
 [1.1.36t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.1.36
 [1.1.35]: https://github.com/kettle-rb/kettle-dev/compare/v1.1.34...v1.1.35

data/README.md

@@ -213,6 +213,21 @@ This gem integrates tightly with [kettle-test](https://github.com/kettle-rb/kett
 
 ```ruby
 require "kettle/test/rspec"
+
+# ... any other config you need to do.
+
+# NOTE: Gemfiles for older rubies (< 2.7) won't have kettle-soup-cover.
+#       The rescue LoadError handles that scenario.
+begin
+  require "kettle-soup-cover"
+  require "simplecov" if Kettle::Soup::Cover::DO_COV # `.simplecov` is run here!
+rescue LoadError => error
+  # check the error message, and re-raise if not what is expected
+  raise error unless error.message.include?("kettle")
+end
+
+# This gem (or app)
+require "gem-under-test"
 ```
 
 ### Rakefile
@@ -457,24 +472,25 @@ What it does:
   - Exports `SOURCE_DATE_EPOCH`, builds (optionally signed), creates gem checksums, and runs `bundle exec rake release` (prompts for signing key + RubyGems MFA OTP as needed).
 - Options:
   - start_step map (skip directly to a phase):
-    - 1: Ensure Bundler >= 2.7.0 and begin full flow
-    - 2: Version detection + sanity checks + prompt to confirm version.rb and CHANGELOG.md
-    - 3: Run bin/setup
-    - 4: Run bin/rake (default task)
-    - 5: Run appraisal:update when Appraisals exists (skip otherwise)
-    - 6: Verify git user.name/email and commit release prep "🔖 Prepare release vX.Y.Z"
-    - 7: Optionally run local CI with nektos/act before pushing (see K_RELEASE_LOCAL_CI, K_RELEASE_LOCAL_CI_WORKFLOW)
-    - 8: Ensure trunk is up-to-date and reconcile with GitHub remote if needed
-    - 9: Push current branch to configured remotes (or default), force-pushing on retry when needed
-    - 10: Monitor CI after push (GitHub Actions and/or GitLab pipelines); progress bar; aborts on failure
-    - 11: Merge feature branch into trunk and push
-    - 12: Checkout trunk and pull latest
-    - 13: Signing checks and guidance (abort when signing enabled but cert missing); respect SKIP_GEM_SIGNING
-    - 14: Build gem (honors SKIP_GEM_SIGNING via env prefix)
-    - 15: Release via `bundle exec rake release` (also creates git tag)
-    - 16: Generate and validate gem checksums (bin/gem_checksums)
-    - 17: Create GitHub release from CHANGELOG when GITHUB_TOKEN present
-    - 18: Push git tags to remotes (to "all" remote only when present; otherwise to each remote)
+    1. Verify Bundler >= 2.7 (always runs; start at 1 to do everything)
+    2. Detect version; RubyGems sanity check; confirm CHANGELOG/version; sync copyright years; update badges/headers
+    3. Run bin/setup
+    4. Run bin/rake (default task)
+    5. Run bin/rake appraisal:update if Appraisals present
+    6. Ensure git user configured; commit release prep
+    7. Optional local CI with `act` (controlled by K_RELEASE_LOCAL_CI)
+    8. Ensure trunk in sync across remotes; rebase feature as needed
+    9. Push current branch to remotes (or 'all' remote)
+    10. Monitor CI after push; abort on failures
+    11. Merge feature into trunk and push
+    12. Checkout trunk and pull latest
+    13. Gem signing checks/guidance (skip with SKIP_GEM_SIGNING=true)
+    14. Build gem (bundle exec rake build)
+    15. Release gem (bundle exec rake release)
+    16. Generate and validate checksums (bin/gem_checksums)
+    17. Push checksum commit
+    18. Create GitHub Release (requires GITHUB_TOKEN)
+    19. Push tags to remotes (final)
 - Examples:
   - After intermittent CI failure, restart from monitoring: `bundle exec kettle-release start_step=10`
 - Tips:

data/Rakefile.example

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# kettle-dev Rakefile v1.1.36 - 2025-10-20
+# kettle-dev Rakefile v1.1.37 - 2025-10-21
 # Ruby 2.3 (Safe Navigation) or higher required
 #
 # MIT License (see License.txt)

data/exe/kettle-release

@@ -43,28 +43,47 @@ end
 # Do not guard with __FILE__ == $PROGRAM_NAME because binstubs use Kernel.load.
 if ARGV.include?("-h") || ARGV.include?("--help")
   puts <<~USAGE
-    Usage: kettle-release [start_step=<number>]
+    Usage: kettle-release [start_step=<1-19>]
 
-    Automates the release flow for a Ruby gem in the host project:
+    Automates the release flow for a Ruby gem in the host project.
+
+    Start steps (use start_step=<n> to begin at that step):
+      1. Verify Bundler >= 2.7 (always runs; start at 1 to do everything)
+      2. Detect version; RubyGems sanity check; confirm CHANGELOG/version; sync copyright years; update badges/headers
+      3. Run bin/setup
+      4. Run bin/rake (default task)
+      5. Run bin/rake appraisal:update if Appraisals present
+      6. Ensure git user configured; commit release prep
+      7. Optional local CI with `act` (controlled by K_RELEASE_LOCAL_CI)
+      8. Ensure trunk in sync across remotes; rebase feature as needed
+      9. Push current branch to remotes (or 'all' remote)
+     10. Monitor CI after push; abort on failures
+     11. Merge feature into trunk and push
+     12. Checkout trunk and pull latest
+     13. Gem signing checks/guidance (skip with SKIP_GEM_SIGNING=true)
+     14. Build gem (bundle exec rake build)
+     15. Release gem (bundle exec rake release)
+     16. Generate and validate checksums (bin/gem_checksums)
+     17. Push checksum commit
+     18. Create GitHub Release (requires GITHUB_TOKEN)
+     19. Push tags to remotes (final)
 
     Options:
-      start_step=<number>         # skip directly to the numbered step (e.g., 10 for CI validation)
-      - Runs bin/setup and bin/rake sanity checks
-      - Prompts to confirm version and changelog updates
-      - Commits a release prep change
-      - Ensures trunk is up-to-date, pushes branch, and monitors CI (GitHub/GitLab)
-      - Merges feature into trunk upon CI success
-      - Builds and releases the gem
-      - Generates checksums (via bin/gem_checksums), then pushes the checksum commit
-      - Optionally creates a GitHub Release
-      - Pushes tags to remotes at the end
+      start_step=<number>         # Begin at the numbered step above (e.g., 10 to resume at CI monitoring)
 
     Environment:
-      SKIP_GEM_SIGNING=true        # skip gem signing during build/release
-      GEM_CERT_USER=<user>         # selects certs/<user>.pem for signing
-      GITHUB_TOKEN / GH_TOKEN      # optional, to query GitHub Actions
-      GITLAB_TOKEN / GL_TOKEN      # optional, to query GitLab pipelines
-      DEBUG=true                   # print backtraces on errors
+      SKIP_GEM_SIGNING=true       # Build/release unsigned; avoids PEM password prompts
+      GEM_CERT_USER=<user>        # Select certs/<user>.pem for signing
+      K_RELEASE_LOCAL_CI=ask|1|0  # Use 'act' locally before push; 'ask' prompts, '1' forces, default off
+      K_RELEASE_LOCAL_CI_WORKFLOW # Name of workflow (without .yml) for local CI; defaults to locked_deps or first
+      GITHUB_TOKEN / GH_TOKEN     # Optional; enables GitHub release creation and API queries
+      GITLAB_TOKEN / GL_TOKEN     # Optional; enables GitLab API queries when applicable
+      DEBUG=true                  # Print backtraces on errors
+
+    Examples:
+      kettle-release                       # full flow from the top (start_step=1)
+      kettle-release start_step=10         # resume by monitoring CI for the current branch
+      SKIP_GEM_SIGNING=true kettle-release start_step=14  # build+release without signing
   USAGE
   exit 0
 end
@@ -77,7 +96,7 @@ begin
   Kettle::Dev::ReleaseCLI.new(start_step: start_step).run
 rescue LoadError => e
   warn("#{script_basename}: could not load dependency: #{e.class}: #{e.message}")
-  warn(e.backtrace.join("\n")) if ENV["DEBUG"]
+  warn(Array(e.backtrace).join("\n")) if ENV["DEBUG"]
   exit(1)
 rescue SystemExit => e
   # Preserve exit status, but ensure at least a newline so shells don't show an empty line only.
@@ -85,6 +104,6 @@ rescue SystemExit => e
   raise
 rescue StandardError => e
   warn("#{script_basename}: unexpected error: #{e.class}: #{e.message}")
-  warn(e.backtrace.join("\n"))
+  warn(Array(e.backtrace).join("\n"))
   exit(1)
 end

data/kettle-dev.gemspec.example

@@ -115,7 +115,7 @@ Gem::Specification.new do |spec|
   #       and preferably a modular one (see gemfiles/modular/*.gemfile).
 
   # Dev, Test, & Release Tasks
-  spec.add_development_dependency("{KETTLE|DEV|GEM}", "~> 1.1")                     # ruby >= 2.3.0
+  spec.add_development_dependency("{KETTLE|DEV|GEM}", "~> 1.1")                           # ruby >= 2.3.0
 
   # Security
   spec.add_development_dependency("bundler-audit", "~> 0.9.2")                      # ruby >= 2.0.0
@@ -128,7 +128,7 @@ Gem::Specification.new do |spec|
 
   # Testing
   spec.add_development_dependency("appraisal2", "~> 3.0")                           # ruby >= 1.8.7, for testing against multiple versions of dependencies
-  spec.add_development_dependency("kettle-test", "~> 1.0", ">= 1.0.5")              # ruby >= 2.3
+  spec.add_development_dependency("kettle-test", "~> 1.0", ">= 1.0.6")              # ruby >= 2.3
 
   # Releasing
   spec.add_development_dependency("ruby-progressbar", "~> 1.13")                    # ruby >= 0

data/lib/kettle/dev/version.rb

@@ -6,7 +6,7 @@ module Kettle
     module Version
       # The gem version.
       # @return [String]
-      VERSION = "1.1.36"
+      VERSION = "1.1.37"
 
       module_function
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kettle-dev
 version: !ruby/object:Gem::Version
-  version: 1.1.36
+  version: 1.1.37
 platform: ruby
 authors:
 - Peter H. Boling
@@ -108,7 +108,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.0.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -118,7 +118,7 @@ dependencies:
         version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.5
+        version: 1.0.6
 - !ruby/object:Gem::Dependency
   name: ruby-progressbar
   requirement: !ruby/object:Gem::Requirement
@@ -395,10 +395,10 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://kettle-dev.galtzo.com/
-  source_code_uri: https://github.com/kettle-rb/kettle-dev/tree/v1.1.36
-  changelog_uri: https://github.com/kettle-rb/kettle-dev/blob/v1.1.36/CHANGELOG.md
+  source_code_uri: https://github.com/kettle-rb/kettle-dev/tree/v1.1.37
+  changelog_uri: https://github.com/kettle-rb/kettle-dev/blob/v1.1.37/CHANGELOG.md
   bug_tracker_uri: https://github.com/kettle-rb/kettle-dev/issues
-  documentation_uri: https://www.rubydoc.info/gems/kettle-dev/1.1.36
+  documentation_uri: https://www.rubydoc.info/gems/kettle-dev/1.1.37
   funding_uri: https://github.com/sponsors/pboling
   wiki_uri: https://github.com/kettle-rb/kettle-dev/wiki
   news_uri: https://www.railsbling.com/tags/kettle-dev