kettle-dev 1.0.10 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e64251f36de1db3a3f0c71d1436758db8a13223b3a5740062a04fa169ae9875
-  data.tar.gz: afb492c0d27d008b779e426f081c0be491dff7616120115668468f9ff2c1872c
+  metadata.gz: 18dc37569a34008ec953339ce7fd69e285bf007f2f1dd035de13856fb2d621ec
+  data.tar.gz: b3afeca255b2fb10fd86c4e48a47679b8652ff7ab9f75c4b8637c7738f83e28b
 SHA512:
-  metadata.gz: 0cc6afa5e3543bab0de8682f0d9a2d45df99a442e2253fe8f028ef190c59cb44710969b9f22e63c4ef4a0e604f96243b616589683ec6ff5d68273cfd2fe0ac40
-  data.tar.gz: 9d5253d1aac3f87db2e76ae013c16a5a71ebfd649f8bbaf882b74f90af2e5bdfe2c99cb6fbb9f83cc4efa094117d26dfd7e898d902fc0eb60a74559dca6f9af7
+  metadata.gz: d12f7394b9aba54d138cbddc74598e03908280f6e4102c0b98a9d326e00909cc5d1cac16f1a5bced75ee694c2606e026bc772088b005abf1a69d9a1d23bf0c93
+  data.tar.gz: 5fc72941ddcc1c21e9e56fd0fffd2eb0b603eff7d1fe60d6cdf55108b8e4c314320be1ed243e5064d89cb604e74e42bdc6756764c42dcf920bc204514fbe539b

data/.envrc

@@ -21,7 +21,7 @@ export K_SOUP_COV_DO=true # Means you want code coverage
 export K_SOUP_COV_COMMAND_NAME="Test Coverage"
 # Available formats are html, xml, rcov, lcov, json, tty
 export K_SOUP_COV_FORMATTERS="html,xml,rcov,lcov,json,tty"
-export K_SOUP_COV_MIN_BRANCH=77 # Means you want to enforce X% branch coverage
+export K_SOUP_COV_MIN_BRANCH=79 # Means you want to enforce X% branch coverage
 export K_SOUP_COV_MIN_LINE=97 # Means you want to enforce X% line coverage
 export K_SOUP_COV_MIN_HARD=true # Means you want the build to fail if the coverage thresholds are not met
 export K_SOUP_COV_MULTI_FORMATTERS=true

data/.github/workflows/coverage.yml

@@ -7,7 +7,7 @@ permissions:
 
 env:
   # Lower than local, which is at 100/100, because rubocop-lts isn't installed in the coverage workflow
-  K_SOUP_COV_MIN_BRANCH: 72
+  K_SOUP_COV_MIN_BRANCH: 74
   K_SOUP_COV_MIN_LINE: 94
   K_SOUP_COV_MIN_HARD: true
   K_SOUP_COV_FORMATTERS: "xml,rcov,lcov,tty"
@@ -116,7 +116,7 @@ jobs:
           hide_complexity: true
           indicators: true
           output: both
-          thresholds: '94 72'
+          thresholds: '94 74'
         continue-on-error: ${{ matrix.experimental != 'false' }}
 
       - name: Add Coverage PR Comment

data/.github/workflows/coverage.yml.example

@@ -0,0 +1,127 @@
+name: Test Coverage
+
+permissions:
+  contents: read
+  pull-requests: write
+  id-token: write
+
+env:
+  K_SOUP_COV_MIN_BRANCH: 100
+  K_SOUP_COV_MIN_LINE: 100
+  K_SOUP_COV_MIN_HARD: true
+  K_SOUP_COV_FORMATTERS: "xml,rcov,lcov,tty"
+  K_SOUP_COV_DO: true
+  K_SOUP_COV_MULTI_FORMATTERS: true
+  K_SOUP_COV_COMMAND_NAME: "Test Coverage"
+
+on:
+  push:
+    branches:
+      - 'main'
+      - "*-stable"
+    tags:
+      - '!*' # Do not execute on tags
+  pull_request:
+    branches:
+      - '*'
+  # Allow manually triggering the workflow.
+  workflow_dispatch:
+
+# Cancels all previous workflow runs for the same branch that have not yet completed.
+concurrency:
+  # The concurrency group contains the workflow name and the branch name.
+  group: "${{ github.workflow }}-${{ github.ref }}"
+  cancel-in-progress: true
+
+jobs:
+  coverage:
+    if: "!contains(github.event.commits[0].message, '[ci skip]') && !contains(github.event.commits[0].message, '[skip ci]')"
+    name: Code Coverage on ${{ matrix.ruby }}@current
+    runs-on: ubuntu-latest
+    continue-on-error: ${{ matrix.experimental || endsWith(matrix.ruby, 'head') }}
+    env: # $BUNDLE_GEMFILE must be set at job level, so it is set for all steps
+      BUNDLE_GEMFILE: ${{ github.workspace }}/${{ matrix.gemfile }}.gemfile
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Coverage
+          - ruby: "ruby"
+            appraisal: "coverage"
+            exec_cmd: "rake test"
+            gemfile: "Appraisal.root"
+            rubygems: latest
+            bundler: latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v5
+
+      - name: Setup Ruby & RubyGems
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: "${{ matrix.ruby }}"
+          rubygems: "${{ matrix.rubygems }}"
+          bundler: "${{ matrix.bundler }}"
+          bundler-cache: false
+
+      # Raw `bundle` will use the BUNDLE_GEMFILE set to matrix.gemfile (i.e. Appraisal.root)
+      # We need to do this first to get appraisal installed.
+      # NOTE: This does not use the main Gemfile at all.
+      - name: Install Root Appraisal
+        run: bundle
+      - name: Appraisal for ${{ matrix.appraisal }}
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle
+      - name: Tests for ${{ matrix.ruby }}@current via ${{ matrix.exec_cmd }}
+        run: bundle exec appraisal ${{ matrix.appraisal }} bundle exec ${{ matrix.exec_cmd }}
+
+      # Do SaaS coverage uploads first
+      - name: Upload coverage to Coveralls
+        if: ${{ !env.ACT }}
+        uses: coverallsapp/github-action@master
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+        continue-on-error: ${{ matrix.experimental != 'false' }}
+
+      - name: Upload coverage to QLTY
+        if: ${{ !env.ACT }}
+        uses: qltysh/qlty-action/coverage@main
+        with:
+          token: ${{secrets.QLTY_COVERAGE_TOKEN}}
+          files: coverage/.resultset.json
+        continue-on-error: ${{ matrix.experimental != 'false' }}
+
+      # Build will fail here if coverage upload fails
+      #   which will hopefully be noticed for the lack of code coverage comments
+      - name: Upload coverage to CodeCov
+        if: ${{ !env.ACT }}
+        uses: codecov/codecov-action@v5
+        with:
+          use_oidc: true
+          fail_ci_if_error: false # optional (default = false)
+          files: coverage/lcov.info,coverage/coverage.xml
+          verbose: true # optional (default = false)
+
+      # Then PR comments
+      - name: Code Coverage Summary Report
+        if: ${{ !env.ACT && github.event_name == 'pull_request' }}
+        uses: irongut/CodeCoverageSummary@v1.3.0
+        with:
+          filename: ./coverage/coverage.xml
+          badge: true
+          fail_below_min: true
+          format: markdown
+          hide_branch_rate: false
+          hide_complexity: true
+          indicators: true
+          output: both
+          thresholds: '100 100'
+        continue-on-error: ${{ matrix.experimental != 'false' }}
+
+      - name: Add Coverage PR Comment
+        uses: marocchino/sticky-pull-request-comment@v2
+        if: ${{ !env.ACT && github.event_name == 'pull_request' }}
+        with:
+          recreate: true
+          path: code-coverage-results.md
+        continue-on-error: ${{ matrix.experimental != 'false' }}

data/.github/workflows/discord-notifier.yml

@@ -24,6 +24,7 @@ on:
 jobs:
   # This workflow contains a single job called "build"
   notify:
+    if: false
     # The type of runner that the job will run on
     runs-on: ubuntu-latest
 
@@ -35,4 +36,4 @@ jobs:
         with:
           webhook: ${{ secrets.DISCORD_WEBHOOK }}
           status: ${{ job.status }}
-          username: GitHub Actions
+          username: GitHub Actions

data/.github/workflows/truffle.yml

@@ -37,14 +37,6 @@ jobs:
       matrix:
         include:
           # NOTE: truffleruby does not support upgrading rubygems.
-          # truffleruby-23.0 (targets Ruby 3.1 compatibility)
-          - ruby: "truffleruby-23.0"
-            appraisal: "ruby-3-1"
-            exec_cmd: "rake test"
-            gemfile: "Appraisal.root"
-            rubygems: default
-            bundler: default
-
           # truffleruby-23.1 (targets Ruby 3.2 compatibility)
           - ruby: "truffleruby-23.1"
             appraisal: "ruby-3-2"

data/.junie/guidelines.md

@@ -128,6 +128,7 @@ Notes
 - NEVER run vanilla rubocop, as it won't handle the linting config properly. Always run rubocop_gradual:autocorrect or rubocop_gradual.
 - Running only a subset of specs is supported but in order to bypass the hard failure due to coverage thresholds, you need to run with K_SOUP_COV_MIN_HARD=false.
 - When adding code that writes to STDOUT, remember most specs silence output unless tagged with :check_output or DEBUG=true.
+- Completion criteria after changes: Only consider your change “done” when the relevant examples pass, as verified by .rspec_status. Do not rely on STDOUT impressions; consult .rspec_status (and example IDs) to confirm green results for the affected files/examples. If you ran a subset, re-run the full suite before finalizing to restore coverage thresholds.
 - Coverage reports: NEVER review the HTML report. Use JSON (preferred), XML, LCOV, or RCOV. For this project, always run tests with K_SOUP_COV_FORMATTERS set to "json".
 - Do NOT modify .envrc in tasks; when running tests locally or in scripts, manually prefix each run, e.g.: K_SOUP_COV_FORMATTERS="json" bin/rspec
 - For all the kettle-soup-cover options, see .envrc and find the K_SOUP_COV_* env vars.

data/Appraisals

@@ -26,6 +26,7 @@ appraise "unlocked_deps" do
   eval_gemfile "modular/coverage.gemfile"
   eval_gemfile "modular/documentation.gemfile"
   eval_gemfile "modular/style.gemfile"
+  eval_gemfile "modular/optional.gemfile"
 end
 
 # Used for head (nightly) releases of ruby, truffleruby, and jruby.
@@ -80,6 +81,7 @@ end
 
 appraise "ruby-3-1" do
   # all versions of git gem are incompatible with truffleruby v23.0, syntactically.
+  # So tests relying on the git gem are skipped, to avoid loading it.
   gem "erb"
   gem "mutex_m", "~> 0.2"
   gem "stringio", "~> 3.0"
@@ -87,7 +89,7 @@ end
 
 appraise "ruby-3-2" do
   # all versions of git gem are incompatible with truffleruby v23.1, syntactically.
-  gem "git", "< 3"
+  # So tests relying on the git gem are skipped, to avoid loading it.
   gem "erb"
   gem "mutex_m", "~> 0.2"
   gem "stringio", "~> 3.0"
@@ -112,6 +114,7 @@ appraise "coverage" do
   gem "mutex_m", "~> 0.2"
   gem "stringio", "~> 3.0"
   eval_gemfile "modular/coverage.gemfile"
+  eval_gemfile "modular/optional.gemfile"
 end
 
 # Only run linter on latest Ruby version (but, in support of oldest supported Ruby version)

data/Appraisals.example

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+# HOW TO UPDATE APPRAISALS:
+#   BUNDLE_GEMFILE=Appraisal.root.gemfile bundle
+#   BUNDLE_GEMFILE=Appraisal.root.gemfile bundle exec appraisal update
+#   bundle exec rake rubocop_gradual:autocorrect
+
+# Lock/Unlock Deps Pattern
+#
+# Two often conflicting goals resolved!
+#
+#  - unlocked_deps.yml
+#    - All runtime & dev dependencies, but does not have a `gemfiles/*.gemfile.lock` committed
+#    - Uses an Appraisal2 "unlocked_deps" gemfile, and the current MRI Ruby release
+#    - Know when new dependency releases will break local dev with unlocked dependencies
+#    - Broken workflow indicates that new releases of dependencies may not work
+#
+#  - locked_deps.yml
+#    - All runtime & dev dependencies, and has a `Gemfile.lock` committed
+#    - Uses the project's main Gemfile, and the current MRI Ruby release
+#    - Matches what contributors and maintainers use locally for development
+#    - Broken workflow indicates that a new contributor will have a bad time
+#
+appraise "unlocked_deps" do
+  eval_gemfile "modular/coverage.gemfile"
+  eval_gemfile "modular/documentation.gemfile"
+  eval_gemfile "modular/style.gemfile"
+  eval_gemfile "modular/optional.gemfile"
+end
+
+# Used for head (nightly) releases of ruby, truffleruby, and jruby.
+# Split into discrete appraisals if one of them needs a dependency locked discretely.
+appraise "head" do
+  gem "mutex_m", ">= 0.2"
+  gem "stringio", ">= 3.0"
+  gem "benchmark", "~> 0.4", ">= 0.4.1"
+end
+
+# Used for current releases of ruby, truffleruby, and jruby.
+# Split into discrete appraisals if one of them needs a dependency locked discretely.
+appraise "current" do
+  gem "mutex_m", ">= 0.2"
+  gem "stringio", ">= 3.0"
+end
+
+appraise "ruby-2-3" do
+end
+
+appraise "ruby-2-4" do
+end
+
+appraise "ruby-2-5" do
+end
+
+appraise "ruby-2-6" do
+  gem "mutex_m", "~> 0.2"
+  gem "stringio", "~> 3.0"
+end
+
+appraise "ruby-2-7" do
+  gem "mutex_m", "~> 0.2"
+  gem "stringio", "~> 3.0"
+end
+
+appraise "ruby-3-0" do
+  gem "mutex_m", "~> 0.2"
+  gem "stringio", "~> 3.0"
+end
+
+appraise "ruby-3-1" do
+  gem "mutex_m", "~> 0.2"
+  gem "stringio", "~> 3.0"
+end
+
+appraise "ruby-3-2" do
+  gem "mutex_m", "~> 0.2"
+  gem "stringio", "~> 3.0"
+end
+
+appraise "ruby-3-3" do
+  gem "mutex_m", "~> 0.2"
+  gem "stringio", "~> 3.0"
+end
+
+# Only run security audit on latest Ruby version
+appraise "audit" do
+  gem "mutex_m", "~> 0.2"
+  gem "stringio", "~> 3.0"
+end
+
+# Only run coverage on latest Ruby version
+appraise "coverage" do
+  gem "mutex_m", "~> 0.2"
+  gem "stringio", "~> 3.0"
+  eval_gemfile "modular/coverage.gemfile"
+  eval_gemfile "modular/optional.gemfile"
+end
+
+# Only run linter on latest Ruby version (but, in support of oldest supported Ruby version)
+appraise "style" do
+  gem "mutex_m", "~> 0.2"
+  gem "stringio", "~> 3.0"
+  eval_gemfile "modular/style.gemfile"
+end

data/CHANGELOG.md

@@ -24,10 +24,65 @@ Please file a bug if you notice a violation of semantic versioning.
 ### Fixed
 ### Security
 
+## [1.0.12] - 2025-08-28
+- TAG: [v1.0.12][1.0.12t]
+- COVERAGE: 97.80% -- 1957/2001 lines in 19 files
+- BRANCH COVERAGE: 79.98% -- 763/954 branches in 19 files
+- 78.70% documented
+### Added
+- CIMonitor to consolidate workflow / pipeline monitoring logic for GH/GL across kettle-release and rake tasks, with handling for:
+  - minutes exhausted
+  - blocked
+  - not configured
+  - normal failures
+  - pending
+  - queued
+  - running
+  - success
+- Ability to restart kettle-release from any failed step, so manual fixed can be applied.
+  - Example (after intermittent failure of CI): `bundle exec kettle-release start_step=10`
+### Fixed
+- added optional.gemfile.example, and handling for it in templating
+- kettle-changelog: ensure a blank line at end of file
+- add sleep(0.2) to ci:act to prevent race condition with stdout flushing
+- kettle-release: ensure SKIP_GEM_SIGNING works as expected with values of "true" or "false"
+  - ensure it doesn't abort the process in CI
+
+## [1.0.11] - 2025-08-28
+- TAG: [v1.0.11][1.0.11t]
+- COVERAGE: 97.90% -- 1959/2001 lines in 19 files
+- BRANCH COVERAGE: 79.98% -- 763/954 branches in 19 files
+- 78.70% documented
+### Added
+- Add more .example templates
+    - .github/workflows/coverage.yml.example
+    - .gitlab-ci.yml.example
+    - Appraisals.example
+- Kettle::Dev::InputAdapter: Input indirection layer for safe interactive prompts in tests; provides gets and readline; documented with YARD and typed with RBS.
+- install task README improvements
+    - extracts emoji grapheme from H1 to apply to gemspec's summary and description
+    - removes badges for unsupported rubies, and major version MRI row if all badges removed
+- new exe script: kettle-changelog - transitions a changelog from unreleased to next release
+### Changed
+- Make 'git' gem dependency optional; fall back to raw `git` commands when the gem is not present (rescues LoadError). See Kettle::Dev::GitAdapter.
+- upgraded to stone_checksums v1.0.2
+- exe scripts now print their name and version as they start up
+### Removed
+- dependency on git gem
+    - git gem is still supported if present and not bypassed by new ENV variable `KETTLE_DEV_DISABLE_GIT_GEM`
+    - no longer a direct dependency
+### Fixed
+- Upgrade stone_checksums for release compatibility with bundler v2.7+
+    - Retains compatibility with older bundler < v2.7
+- Ship all example templates with gem
+- install task README preservation
+    - preserves H1 line, and specific H2 headed sections
+    - preserve table alignment
+
 ## [1.0.10] - 2025-08-24
 - TAG: [v1.0.10][1.0.10t]
-- COVERAGE:  97.68% -- 1685/1725 lines in 17 files
-- BRANCH COVERAGE:  77.54% -- 618/797 branches in 17 files- 95.35% documented
+- COVERAGE: 97.68% -- 1685/1725 lines in 17 files
+- BRANCH COVERAGE: 77.54% -- 618/797 branches in 17 files- 95.35% documented
 - 77.00% documented
 ### Added
 - runs git add --all before git commit, to ensure all files are committed.
@@ -58,7 +113,7 @@ Please file a bug if you notice a violation of semantic versioning.
 ## [1.0.8] - 2025-08-24
 - TAG: [v1.0.8][1.0.8t]
 - COVERAGE: 100.00% -- 130/130 lines in 7 files
-- BRANCH COVERAGE:  96.00% -- 48/50 branches in 7 files
+- BRANCH COVERAGE: 96.00% -- 48/50 branches in 7 files
 - 95.35% documented
 ### Fixed
 - Can't add checksums to the gem package, because it changes the checksum (duh!)
@@ -66,7 +121,7 @@ Please file a bug if you notice a violation of semantic versioning.
 ## [1.0.7] - 2025-08-24
 - TAG: [v1.0.7][1.0.7t]
 - COVERAGE: 100.00% -- 130/130 lines in 7 files
-- BRANCH COVERAGE:  96.00% -- 48/50 branches in 7 files
+- BRANCH COVERAGE: 96.00% -- 48/50 branches in 7 files
 - 95.35% documented
 ### Fixed
 - Reproducible builds, with consistent checksums, by *not* using SOURCE_DATE_EPOCH.
@@ -75,7 +130,7 @@ Please file a bug if you notice a violation of semantic versioning.
 ## [1.0.6] - 2025-08-24
 - TAG: [v1.0.6][1.0.6t]
 - COVERAGE: 100.00% -- 130/130 lines in 7 files
-- BRANCH COVERAGE:  96.00% -- 48/50 branches in 7 files
+- BRANCH COVERAGE: 96.00% -- 48/50 branches in 7 files
 - 95.35% documented
 ### Fixed
 - kettle-release: ensure SOURCE_DATE_EPOCH is applied within the same shell for both build and release by prefixing the commands with the env var (e.g., `SOURCE_DATE_EPOCH=$epoch bundle exec rake build` and `... rake release`); prevents losing the variable across shell boundaries and improves reproducible checksums.
@@ -83,7 +138,7 @@ Please file a bug if you notice a violation of semantic versioning.
 ## [1.0.5] - 2025-08-24
 - TAG: [v1.0.5][1.0.5t]
 - COVERAGE: 100.00% -- 130/130 lines in 7 files
-- BRANCH COVERAGE:  96.00% -- 48/50 branches in 7 files
+- BRANCH COVERAGE: 96.00% -- 48/50 branches in 7 files
 - 95.35% documented
 ### Fixed
 - kettle-release: will run regardless of how it is invoked (i.e. works as binstub)
@@ -91,7 +146,7 @@ Please file a bug if you notice a violation of semantic versioning.
 ## [1.0.4] - 2025-08-24
 - TAG: [v1.0.4][1.0.4t]
 - COVERAGE: 100.00% -- 130/130 lines in 7 files
-- BRANCH COVERAGE:  96.00% -- 48/50 branches in 7 files
+- BRANCH COVERAGE: 96.00% -- 48/50 branches in 7 files
 - 95.35% documented
 ### Added
 - kettle-release: checks all remotes for a GitHub remote and syncs origin/trunk with it; prompts to rebase or --no-ff merge when histories diverge; pushes to both origin and the GitHub remote on merge; uses the GitHub remote for GitHub Actions CI checks, and also checks GitLab CI when a GitLab remote and .gitlab-ci.yml are present.
@@ -159,26 +214,30 @@ 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://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.10...HEAD
-[1.0.10]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.9...v1.0.10
-[1.0.10t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.10
-[1.0.9]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.8...v1.0.9
-[1.0.9t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.9
-[1.0.8]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.7...v1.0.8
-[1.0.8t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.8
-[1.0.7]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.6...v1.0.7
-[1.0.7t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.7
-[1.0.6]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.5...v1.0.6
-[1.0.6t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.6
-[1.0.5]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.4...v1.0.5
-[1.0.5t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.5
-[1.0.4]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.3...v1.0.4
-[1.0.4t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.4
-[1.0.3]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.2...v1.0.3
-[1.0.3t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.3
-[1.0.2]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.1...v1.0.2
-[1.0.2t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.2
+[Unreleased]: https://github.com/kettle-rb/kettle-dev/compare/v1.0.12...HEAD
+[1.0.0]: https://github.com/kettle-rb/kettle-dev/compare/a427c302df09cfe4253a7c8d400333f9a4c1a208...v1.0.0
+[1.0.0t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.0
 [1.0.1]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.0...v1.0.1
-[1.0.1t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.1
-[1.0.0]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/a427c302df09cfe4253a7c8d400333f9a4c1a208...v1.0.0
-[1.0.0t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.0
+[1.0.1t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.1
+[1.0.2]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.1...v1.0.2
+[1.0.2t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.2
+[1.0.3]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.2...v1.0.3
+[1.0.3t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.3
+[1.0.4]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.3...v1.0.4
+[1.0.4t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.4
+[1.0.5]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.4...v1.0.5
+[1.0.5t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.5
+[1.0.6]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.5...v1.0.6
+[1.0.6t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.6
+[1.0.7]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.6...v1.0.7
+[1.0.7t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.7
+[1.0.8]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.7...v1.0.8
+[1.0.8t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.8
+[1.0.9]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.8...v1.0.9
+[1.0.9t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.9
+[1.0.10]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.9...v1.0.10
+[1.0.10t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.10
+[1.0.11]: https://github.com/kettle-rb/kettle-dev/compare/v1.0.10...v1.0.11
+[1.0.11t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.11
+[1.0.12]: https://github.com/kettle-rb/kettle-dev/compare/v1.0.11...v1.0.12
+[1.0.12t]: https://github.com/kettle-rb/kettle-dev/releases/tag/v1.0.12

data/CHANGELOG.md.example

@@ -27,7 +27,7 @@ Please file a bug if you notice a violation of semantic versioning.
 ## [1.0.1] - 2025-08-24
 - TAG: [v1.0.1][1.0.1t]
 - COVERAGE: 100.00% -- 130/130 lines in 7 files
-- BRANCH COVERAGE:  96.00% -- 48/50 branches in 7 files
+- BRANCH COVERAGE: 96.00% -- 48/50 branches in 7 files
 - 100% documented
 ### Fixed
 - bugfix: oopsie
@@ -35,13 +35,13 @@ Please file a bug if you notice a violation of semantic versioning.
 ## [1.0.0] - 2025-08-24
 - TAG: [v1.0.0][1.0.0t]
 - COVERAGE: 100.00% -- 130/130 lines in 7 files
-- BRANCH COVERAGE:  96.00% -- 48/50 branches in 7 files
+- BRANCH COVERAGE: 96.00% -- 48/50 branches in 7 files
 - 100% documented
 ### Added
 - Initial release
 
 [Unreleased]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.0...HEAD
-[1.0.1]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.0...v1.0.1
-[1.0.1t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.1
 [1.0.0]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/a427c302df09cfe4253a7c8d400333f9a4c1a208...v1.0.0
 [1.0.0t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.0
+[1.0.1]: https://gitlab.com/kettle-rb/kettle-dev/-/compare/v1.0.0...v1.0.1
+[1.0.1t]: https://gitlab.com/kettle-rb/kettle-dev/-/tags/v1.0.1

data/CONTRIBUTING.md

@@ -22,6 +22,42 @@ Follow these instructions:
 6. Make sure to add tests for it. This is important, so it doesn't break in a future release.
 7. Create new Pull Request.
 
+## Environment Variables for Local Development
+
+Below are the primary environment variables recognized by stone_checksums (and its integrated tools). Unless otherwise noted, set boolean values to the string "true" to enable.
+
+General/runtime
+- DEBUG: Enable extra internal logging for this library (default: false)
+- REQUIRE_BENCH: Enable `require_bench` to profile requires (default: false)
+- CI: When set to true, adjusts default rake tasks toward CI behavior
+
+Coverage (kettle-soup-cover / SimpleCov)
+- K_SOUP_COV_DO: Enable coverage collection (default: true in .envrc)
+- K_SOUP_COV_FORMATTERS: Comma-separated list of formatters (html, xml, rcov, lcov, json, tty)
+- K_SOUP_COV_MIN_LINE: Minimum line coverage threshold (integer, e.g., 100)
+- K_SOUP_COV_MIN_BRANCH: Minimum branch coverage threshold (integer, e.g., 100)
+- K_SOUP_COV_MIN_HARD: Fail the run if thresholds are not met (true/false)
+- K_SOUP_COV_MULTI_FORMATTERS: Enable multiple formatters at once (true/false)
+- K_SOUP_COV_OPEN_BIN: Path to browser opener for HTML (empty disables auto-open)
+- MAX_ROWS: Limit console output rows for simplecov-console (e.g., 1)
+  Tip: When running a single spec file locally, you may want `K_SOUP_COV_MIN_HARD=false` to avoid failing thresholds for a partial run.
+
+GitHub API and CI helpers
+- GITHUB_TOKEN or GH_TOKEN: Token used by `ci:act` and release workflow checks to query GitHub Actions status at higher rate limits
+
+Releasing and signing
+- SKIP_GEM_SIGNING: If set, skip gem signing during build/release
+- GEM_CERT_USER: Username for selecting your public cert in `certs/<USER>.pem` (defaults to $USER)
+- SOURCE_DATE_EPOCH: Reproducible build timestamp. `kettle-release` will set this automatically for the session.
+
+Git hooks and commit message helpers (exe/kettle-commit-msg)
+- GIT_HOOK_BRANCH_VALIDATE: Branch name validation mode (e.g., `jira`) or `false` to disable
+- GIT_HOOK_FOOTER_APPEND: Append a footer to commit messages when goalie allows (true/false)
+- GIT_HOOK_FOOTER_SENTINEL: Required when footer append is enabled — a unique first-line sentinel to prevent duplicates
+- GIT_HOOK_FOOTER_APPEND_DEBUG: Extra debug output in the footer template (true/false)
+
+For a quick starting point, this repository’s `.envrc` shows sane defaults, and `.env.local` can override them locally.
+
 ## Appraisals
 
 From time to time the Appraisal2 gemfiles in `gemfiles/` will need to be updated.
@@ -110,7 +146,7 @@ NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some v
 
 #### Automated process
 
-Run `kettle-release`.
+Run `bundle exec kettle-release`.
 
 #### Manual process
 

data/Gemfile

@@ -30,3 +30,6 @@ eval_gemfile "gemfiles/modular/style.gemfile"
 
 # Documentation
 eval_gemfile "gemfiles/modular/documentation.gemfile"
+
+# Optional
+eval_gemfile "gemfiles/modular/optional.gemfile"

data/Gemfile.example

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+git_source(:gitlab) { |repo_name| "https://gitlab.com/#{repo_name}" }
+
+#### IMPORTANT #######################################################
+# Gemfile is for local development ONLY; Gemfile is NOT loaded in CI #
+####################################################### IMPORTANT ####
+
+# Include dependencies from <gem name>.gemspec
+gemspec
+
+platform :mri do
+  # Debugging - Ensure ENV["DEBUG"] == "true" to use debuggers within spec suite
+  # Use binding.break, binding.b, or debugger in code
+  gem "debug", ">= 1.0.0"                  # ruby >= 2.7
+  gem "gem_bench", "~> 2.0", ">= 2.0.5"
+
+  # Dev Console - Binding.pry - Irb replacement
+  gem "pry", "~> 0.14"                     # ruby >= 2.0
+end
+
+# Code Coverage
+eval_gemfile "gemfiles/modular/coverage.gemfile"
+
+# Linting
+eval_gemfile "gemfiles/modular/style.gemfile"
+
+# Documentation
+eval_gemfile "gemfiles/modular/documentation.gemfile"
+
+# Optional
+eval_gemfile "gemfiles/modular/optional.gemfile"