kettle-dev 1.0.9 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32a4bff14544feed4dc60644fe0bb8d0ed1a76cb1f49c0144c8f9748e23ea993
-  data.tar.gz: d574fb5dc72da3caf7ee83f64fb064606930d33df23ff6f9a6a907692a21fbe8
+  metadata.gz: 913b6449dd3d5d61bc20384f02a12cb6296f9cbc9e6fdc1255c1fabeb9332034
+  data.tar.gz: ccb5f23873871c1e152d6394b4b5b96ea73ecb5306032710c637e948e7012741
 SHA512:
-  metadata.gz: f68fef35d7bd888e0132e68e27cfcf31f18ba6098ecbccebeadab0cb4154f1fd12ce32fdce828a5699a18362893059ea4302224084a7446fb90b7a12aaee00b5
-  data.tar.gz: ac0dea1fca1ea03add3375fa9f8b884f5b57394d45db39c1b00caebe8bcb33f79a66b9d88ef020a4edc3b19d4630086625fda371522953a48f1f38c5994307af
+  metadata.gz: a86a6391cdb16fff03bc84ef00a50c62a1d86d775f6527bda5693e5bc395ab45be775480037436c9a3460cc557584fc16ea35e85bdb939ff983b5db10df69fcc
+  data.tar.gz: d492c8141e8a4899a1c742efc3e09afa38c97fdf3c667c92d0357f5ff1e0c460b9164ad1373a03d4696bad6b8406202c247c5d471cafccf5f29ea6ac2bb81912

checksums.yaml.gz.sig

@@ -1,2 +1,2 @@
-��n��g8-
-{�V)v�\X5��wN������߶�;�̆�'d����s[����#��ar�?��,���F�j���+���ENs��aҹ:0�H���x�N�MVʎ�դi$r	̆�-,X�e��پ`�w2��6c�s��F�Ƌ.����.?ASv(�F$_ɒ8�S�AG;x�B�aiBݷN\_����L5�ݥ�}F~�Ff�fK�������ߋ���E�`���J�5'��T��[ja
�)	���~��e&�`?y=�H��쬹کRdߎ��Ӱ�T=�*�!SJ�-	��Z����a�}����ga-y��zo�z����J�E���9�f-;Y�}��|�N[S��K�ٗC��œSG�L�U@
+�|�ũ&���TH����l,��l���À%+`�=.z�FO�rDEZ1������&0Î:*��J��[oDz="B��TXz
�㎟��΅W��
+��q�Mbk�J<���tpcYJ�Sm��*"��C_�#0��p������ph(A�D_��!��~�_

data/.envrc

@@ -1,6 +1,7 @@
 # Run any command in this library's bin/ without the bin/ prefix!
-PATH_add bin
+# Prefer exe version over binstub
 PATH_add exe
+PATH_add bin
 
 # Only add things to this file that should be shared with the team.
 
@@ -20,8 +21,8 @@ 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=96 # Means you want to enforce X% branch coverage
-export K_SOUP_COV_MIN_LINE=100 # Means you want to enforce X% line 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
 export K_SOUP_COV_OPEN_BIN= # Means don't try to open coverage results in browser

data/.github/workflows/coverage.yml

@@ -7,8 +7,8 @@ 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: 90
-  K_SOUP_COV_MIN_LINE: 95
+  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"
   K_SOUP_COV_DO: true
@@ -116,7 +116,7 @@ jobs:
           hide_complexity: true
           indicators: true
           output: both
-          thresholds: '95 90'
+          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

@@ -120,13 +120,14 @@ This document captures project-specific knowledge to streamline setup, testing,
 
 Quick start
 1) bundle install
-2) K_SOUP_COV_FORMATTERS="xml,rcov,lcov,json" bin/rspec (generates coverage reports in coverage/ in the specified formats, only choose the formats you need)
-3) Optional local HTML coverage report: K_SOUP_COV_FORMATTERS="html" bin/rspec (generates HTML coverage report in coverage/ - but this is too verbose for AI, so Junie should use one of the more terse formats, like rcov, lcov, or json)
-4) Static analysis: bundle exec rake rubocop_gradual:check && bundle exec rake reek
+2) K_SOUP_COV_FORMATTERS="json" bin/rspec (generates a JSON coverage report with both line and branch data in coverage/. Use this single format.)
+3) Static analysis: bundle exec rake rubocop_gradual:check && bundle exec rake reek
 
 Notes
 - ALWAYS Run bundle exec rake rubocop_gradual:autocorrect as the final step before completing a task, to lint and autocorrect any remaining issues. Then if there are new lint failures, attempt to correct them manually.
 - 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.
+- 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/.simplecov

@@ -4,4 +4,8 @@ require "kettle/soup/cover/config"
 # It is controlled by ENV variables, which are set in .envrc and loaded via `direnv allow`
 # If the values for minimum coverage need to change, they should be changed both there,
 #   and in 2 places in .github/workflows/coverage.yml.
-SimpleCov.start
+SimpleCov.start do
+  track_files "lib/**/*.rb"
+  track_files "lib/**/*.rake"
+  track_files "exe/*.rb"
+end

data/Appraisals

@@ -79,12 +79,16 @@ appraise "ruby-3-0" do
 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"
 end
 
 appraise "ruby-3-2" do
+  # all versions of git gem are incompatible with truffleruby v23.1, 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"
@@ -109,6 +113,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,102 @@
+# 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"
+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"
+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,6 +24,56 @@ Please file a bug if you notice a violation of semantic versioning.
 ### Fixed
 ### Security
 
+## [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
+- 77.00% documented
+### Added
+- runs git add --all before git commit, to ensure all files are committed.
+### Changed
+- This gem is now loaded via Ruby's standard `autoload` feature.
+- Bundler is always expected, and most things probably won't work without it.
+- exe/ scripts and rake tasks logic is all now moved into classes for testability, and is nearly fully covered by tests.
+- New Kettle::Dev::GitAdapter class is an adapter pattern wrapper for git commands
+- New Kettle::Dev::ExitAdapter class is an adapter pattern wrapper for Kernel.exit and Kernel.abort within this codebase.
+### Removed
+- attempts to make exe/* scripts work without bundler. Bundler is required.
+### Fixed
+- `Kettle::Dev::ReleaseCLI#detect_version` handles gems with multiple VERSION constants
+- `kettle:dev:template` task was fixed to copy `.example` files with the destination filename lacking the `.example` extension, except for `.env.local.example`
+
 ## [1.0.9] - 2025-08-24
 - TAG: [v1.0.9][1.0.9t]
 - COVERAGE: 100.00% -- 130/130 lines in 7 files
@@ -39,7 +89,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!)
@@ -47,7 +97,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.
@@ -56,7 +106,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.
@@ -64,7 +114,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)
@@ -72,7 +122,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.
@@ -140,24 +190,29 @@ 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.9...HEAD
-[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.11...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
+

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.
@@ -51,6 +87,12 @@ To run all tests
 bundle exec rake test
 ```
 
+### Spec organization (required)
+
+- For each class or module under `lib/`, keep all of its unit tests in a single spec file under `spec/` that mirrors the path and file name (e.g., specs for `lib/kettle/dev/release_cli.rb` live in `spec/kettle/dev/release_cli_spec.rb`).
+- Do not create ad-hoc "_more" or split spec files for the same class/module. Consolidate all unit tests into the main spec file for that class/module.
+- Only integration scenarios that intentionally span multiple classes belong in `spec/integration/`.
+
 ## Lint It
 
 Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
@@ -104,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"