standard-rubocop-lts 2.0.4 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae7311a66c1b2e153c8b58e441c652d29b2c48fae56c60e4b3fa054fd2d1b347
-  data.tar.gz: 233d3079f5a73e6b8c95d48be49191c4a982b09be7fb82894bd73f2f696bceec
+  metadata.gz: 53033285bf53ab6e80dbfa7cb21bac76160b919460ef3b7ccdc067d04941b710
+  data.tar.gz: 1406049ffcd70df874bee3e1c0298f65a9381345917e12e1f3dd21477ea9f6de
 SHA512:
-  metadata.gz: 5e60cdc6d199e46d4097be7b38982abe8189f05962f705c8fbc1349878ae7ec754727682cc4a82eb68f9e02b984dca99c9a8bba3aee489920d1c0dc9fa8c7cbc
-  data.tar.gz: 5611f769a873abe640e6cbc8e444b1b9cfa19080a09f9cf00f5d9a4e1c76e52e75b04525f0f33b23a0d16ffbcb76b7902bfbdf34911b21a2f2147fbfb39fdd59
+  metadata.gz: 771d925112e79f198d220f620c6c2684811359cba9d16ce5289c0f7f6c911ad3472303f85df64d1b41af43d66a42b61353178580f5951688aed4897749f7e7fb
+  data.tar.gz: 2ef6381045ab355ddcb3db539607fed979f6f56995bb9b7e2e378bef051d4d30ee896f4c846443778e4a45dd6764374c1298157e71c67eed492921494607c429

data/CHANGELOG.md

@@ -1,67 +1,127 @@
 # Changelog
+
+[![SemVer 2.0.0][📌semver-img]][📌semver] [![Keep-A-Changelog 1.0.0][📗keep-changelog-img]][📗keep-changelog]
+
 All notable changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+The format is based on [Keep a Changelog][📗keep-changelog],
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html),
+and [yes][📌major-versions-not-sacred], platform and engine support are part of the [public API][📌semver-breaking].
+Please file a bug if you notice a violation of semantic versioning.
+
+[📌semver]: https://semver.org/spec/v2.0.0.html
+[📌semver-img]: https://img.shields.io/badge/semver-2.0.0-FFDD67.svg?style=flat
+[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
+[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
+[📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
+[📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
 
 ## [Unreleased]
+
 ### Added
+
 ### Changed
-### Fixed
+
+### Deprecated
+
 ### Removed
 
+### Fixed
+
+### Security
+
+## [2.0.5] - 2026-06-07
+
+- TAG: [v2.0.5][2.0.5t]
+- COVERAGE: 100.00% -- 19/19 lines in 4 files
+- BRANCH COVERAGE: 0.00% -- 0/0 branches in 4 files
+- 71.43% documented
+
+### Fixed
+
+- Disabled autocorrection for `Style/RedundantParentheses`, preventing invalid Ruby from grouped `and` / `or` method arguments.
+
 ## [2.0.4] 2026-06-01
+
 ### Added
+
 ### Changed
+
 - Updated dependency floors:
   - `standard` to `~> 1.54`, `>= 1.54.0`.
   - `standard-performance` to `~> 1.9`, `>= 1.9.0`.
   - `version_gem` to `~> 1.1`, `>= 1.1.9`.
   - Release, lint, and test dependencies to their latest compatible floors.
 - Corrected gem metadata to declare the Ruby 3.2 runtime floor that has been implicit since the last major release.
+
 ### Fixed
+
 ### Removed
 
 ## [2.0.3] 2026-06-01
+
 ### Added
+
 ### Changed
+
 - Required `kettle-soup-cover` v1.1.3 for release specs.
+
 ### Fixed
+
 ### Removed
 
 ## [2.0.2] 2026-05-30
+
 ### Added
+
 ### Changed
+
 - Updated release and documentation dependencies.
+
 ### Fixed
+
 ### Removed
+
 - rubocop-shopify as a transitive dependency (removed from all rubocop-rubyN_N gems)
 
 ## [2.0.0] 2025-04-17
+
 - COVERAGE: 100.00% -- 18/18 lines in 4 files
 - BRANCH COVERAGE: 100.00% -- 0/0 branches in 4 files
 - 100.00% documented
+
 ### Added
+
 - `stone_checksums` v1.0.0 for release checksums
 - Rules to prevent churn in bin/bundle
 - Ability to package gem without signing (e.g. for linux distros)
+
 ### Changed
+
 - RuboCop 1.72+ (new plugin system)
 - Contributor Covenant v2.1
 - Upgrade to version_gem v1.1.7
+
 ### Fixed
+
 - (Better) Linting Support for Ruby 1.8, 1.9, 2.0
+
 ### Removed
+
 - Runtime Support for Ruby 2.7, 3.0, 3.1
   - Minimum runtime is Ruby 3.2
 
 ## [1.0.10] 2024-03-23
+
 ### Added
+
 - Moved development dependencies back to gemspec
   - See: https://github.com/rubygems/rubygems/discussions/5065#discussioncomment-7031586
 - kettle-soup-cover v1.0.2 for Code Coverage (dev dependency)
 - rspec-stubbed_env v1.0.1 for testing ENV variable-based logic (dev dependency)
+
 ### Changed
+
 - Disable `Rake/MethodDefinitionInTask` Cop
   - Cop is 66% incorrect, and hasn't been fixed in 2+ years.
   - See: https://github.com/rubocop/rubocop-rake/issues/42
@@ -84,26 +144,36 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - rubocop-md v1.2.2 (dev dependency)
 - rubocop-rspec 2.27.1 (dev dependency)
 - rubocop-shopify 2.15.1 (dev dependency)
+
 ### Fixed
+
 - AllCops/TargetRubyVersion is now set according to:
   - `rubocop-lts` version, or
   - `rubocop-ruby*_*` version
 
 ## [1.0.9] 2023-09-20
+
 ### Changed
+
 - standard v1.31.1
 - standard-performance v1.2
 - simplecov-rcov dev dependency back to mainline release 0.3.3
+
 ### Fixed
+
 - `Gemspec/DevelopmentDependencies` Cop changed to "gemspec"
   - See: https://github.com/rubygems/rubygems/discussions/5065#discussioncomment-7031586
 
 ## [1.0.8] 2023-07-07
+
 ### Fixed
+
 - compatibility with changes from standard v1.30.1
 
 ## [1.0.7] 2023-06-08
+
 ### Changed
+
 - follow best practices for gemspec
   - put all dev dependencies in Gemfile
   - See: https://github.com/rubygems/rubygems/discussions/5065
@@ -111,60 +181,93 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - improve documentation
 
 ## [1.0.6] 2023-06-03
+
 ### Fixed
+
 - ship internal configs with gem
 
 ## [1.0.5] 2023-06-03
+
 ### Fixed
+
 - require deps for configs 1.9 - 3.3
 
 ## [1.0.4] 2023-06-03
+
 ### Fixed
+
 - rubocop-shopify > standard gem family of rules
   - v1.0.0 intended for rubocop-shopify to override standard's rules, now it actually does
   - override mechanism in rubocop.yml config is counter-intuitive :(
 - Stop doubly loading style libs and configs with more careful config structure
+
 ### Changed
+
 - disable several rubocop-performance cops that are bad cops
 
 ## [1.0.3] 2023-05-29
+
 ### Added
+
 - Gem releases are now signed!
+
 ### Fixed
+
 - URIs in gemspec (now point to GitLab)
 
 ## [1.0.2] 2023-05-29
+
 ### Added
+
 - `version_gem` for library version introspection
+
 ### Changed
+
 - Set Style/SymbolArray to brackets for Ruby < 2.0 compat
   - Previously only set for Ruby 1.8
 - Set Style/WordArray to brackets for Ruby < 2.0 compat
   - Previously only set for Ruby 1.8
 - Disable Style/PercentLiteralDelimiters for Ruby < 2.0 compat
 - `Standard::Rubocop::Lts::VERSION` refactored to `Standard::Rubocop::Lts::Version::VERSION`
+
 ### Fixed
+
 - Removed obsolete loading of `standard-custom`'s now defunct `config/ruby-2.2.yml`
   - See: https://github.com/standardrb/standard-custom/issues/2
+
 ### Removed
+
 - Duplicated lines from `README.md`
 - Circular dependency in gemspec (on `standard-rubocop-lts`, which is this gem)
 
 ## [1.0.2] 2023-05-29
+
 ### Changed
+
 - Update to standard 1.28.4
 
 ## [1.0.1] 2023-04-16
+
 ### Fixed
+
 - config/*.yml rubocop configs were not shipped with v1.0.0
+
 ### Changed
+
 - Minimum Ruby Version is 2.7
 
 ## [1.0.0] 2023-04-16 [YANKED]
+
 ### Added
+
 - Initial release
 
-[Unreleased]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.4...HEAD
+[Unreleased]: https://github.com/rubocop-lts/standard-rubocop-lts/compare/v2.0.5...HEAD
+[2.0.5]: https://github.com/rubocop-lts/standard-rubocop-lts/compare/v2.0.4...v2.0.5
+[2.0.5t]: https://github.com/rubocop-lts/standard-rubocop-lts/releases/tag/v2.0.5
+[2.0.4]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.3...v2.0.4
+[2.0.3]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.2...v2.0.3
+[2.0.2]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.0...v2.0.2
 [1.0.11]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.10...v1.0.11
 [1.0.10]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.9...v1.0.10
 [1.0.9]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.8...v1.0.9
@@ -176,7 +279,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 [1.0.3]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.2...v1.0.3
 [1.0.2]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.1...v1.0.2
 [1.0.1]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v1.0.0...v1.0.1
-[1.0.0]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/0c0f82c0eeda184afb5c2c7a3d6b43c10f2d4c1c...v1.0.0
-[2.0.3]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.2...v2.0.3
-[2.0.2]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.0...v2.0.2
-[2.0.4]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/compare/v2.0.3...v2.0.4
+[1.0.0]: https://github.com/rubocop-lts/standard-rubocop-lts/compare/0c0f82c0eeda184afb5c2c7a3d6b43c10f2d4c1c...v1.0.0

data/CITATION.cff

@@ -0,0 +1,20 @@
+cff-version: 1.2.0
+title: "standard-rubocop-lts"
+message: >-
+  If you use this work and you want to cite it,
+  then you can use the metadata from this file.
+type: software
+authors:
+  - given-names: "Peter H."
+    family-names: "Boling"
+    email: "floss@glatzo.com"
+    affiliation: "galtzo.com"
+    orcid: 'https://orcid.org/0009-0008-8519-441X'
+identifiers:
+  - type: url
+    value: 'https://github.com/rubocop-lts/standard-rubocop-lts'
+    description: "standard-rubocop-lts"
+repository-code: 'https://github.com/rubocop-lts/standard-rubocop-lts'
+abstract: >-
+  standard-rubocop-lts
+license: See license file

data/CODE_OF_CONDUCT.md

@@ -1,4 +1,3 @@
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge
@@ -61,7 +60,7 @@ representative at an online or offline event.
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
 reported to the community leaders responsible for enforcement at
-[![Contact BDFL][🚂bdfl-contact-img]][🚂bdfl-contact].
+[![Contact Maintainer][🚂maint-contact-img]][🚂maint-contact].
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the
@@ -131,5 +130,5 @@ For answers to common questions about this code of conduct, see the FAQ at
 [Mozilla CoC]: https://github.com/mozilla/diversity
 [FAQ]: https://www.contributor-covenant.org/faq
 [translations]: https://www.contributor-covenant.org/translations
-[🚂bdfl-contact]: http://www.railsbling.com/contact
-[🚂bdfl-contact-img]: https://img.shields.io/badge/Contact-BDFL-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red
+[🚂maint-contact]: http://www.railsbling.com/contact
+[🚂maint-contact-img]: https://img.shields.io/badge/Contact-Maintainer-0093D0.svg?style=flat&logo=rubyonrails&logoColor=red

data/CONTRIBUTING.md

@@ -1,60 +1,195 @@
 # Contributing
 
-Bug reports and pull requests are welcome on GitLab at [https://gitlab.com/rubocop-lts/standard-rubocop-lts][🚎src-main]
-. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to
+Bug reports and pull requests are welcome on [CodeBerg][📜src-cb], [GitLab][📜src-gl], or [GitHub][📜src-gh].
+This project should be a safe, welcoming space for collaboration, so contributors agree to adhere to
 the [code of conduct][🤝conduct].
 
-To submit a patch, please fork the project and create a patch with tests.
-Once you're happy with it send a pull request.
+To submit a patch, please fork the project, create a patch with tests, and send a pull request.
 
-We [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] so if you make changes, remember to update it.
+Remember to [![Keep A Changelog][📗keep-changelog-img]][📗keep-changelog] if you make changes.
 
-## You can help!
+## Developer Certificate of Origin
 
-Take a look at the `reek` list which is the file called `REEK` and find something to improve.
+In order to protect users of this project, we require all contributors to comply with the
+[Developer Certificate of Origin](https://developercertificate.org/).
+This ensures that all contributions are properly licensed and attributed.
 
-Simply follow these instructions:
+## Help out!
 
-1. Fork the repository
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Make some fixes.
-4. Commit your changes (`git commit -am 'Added some feature'`)
-5. Push to the branch (`git push origin my-new-feature`)
-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.
+Take a look at the open issues and pull requests, or use the gem and find something to improve.
 
-## The Reek List
+Follow these instructions:
 
-Take a look at the `reek` list which is the file called `REEK` and find something to improve.
+1. Join the Discord: [![Live Chat on Discord][✉️discord-invite-img]][✉️discord-invite]
+2. Fork the repository
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Make some fixes.
+5. Commit your changes (`git commit -am 'Added some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Make sure to add tests for it. This is important, so it doesn't break in a future release.
+8. Create new Pull Request.
+9. Announce it in the channel for this org in the [Discord][✉️discord-invite]!
 
-To refresh the `reek` list:
+## Executables vs Rake tasks
 
-```bash
-bundle exec reek > REEK
+Executables shipped by dependencies, such as kettle-dev, and stone_checksums, are available
+after running `bin/setup`. These include:
+
+- gem_checksums
+- kettle-changelog
+- kettle-commit-msg
+- kettle-dev-setup
+- kettle-dvcs
+- kettle-pre-release
+- kettle-readme-backers
+- kettle-release
+
+There are many Rake tasks available as well. You can see them by running:
+
+```shell
+bin/rake -T
+```
+
+## Code quality checks
+
+Run the Reek task when you want a smell check that fails on current findings:
+
+```shell
+bin/rake reek
+```
+
+Refresh the checked-in `REEK` backlog through the rake task, not by redirecting
+the raw `reek` executable output. The rake task uses the project bundle and
+avoids stale generated binstubs shadowing the Reek gem executable:
+
+```shell
+bin/rake reek:update
+```
+
+## 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 `mise.toml`)
+- 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.
+  - Not needed on bundler >= 2.7.0, as reproducible builds have become the default.
+
+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)
+
+Git diff driver setup
+- Local setup writes repository `.gitattributes` entries and local Git `diff.smorg-*` command config so this checkout uses StructuredMerge semantic diffs.
+- Global setup registers `diff.smorg-*` commands once in the user Git config; use it when you work across several StructuredMerge-enabled repositories.
+- Include-file setup writes `.git/smorg/config` and includes it from local Git config, keeping command registrations out of the repository files.
+- Git hosting forges generally ignore external diff drivers, so pull request views may still show raw textual diffs even when local `git diff` uses semantic drivers.
+
+```console
+K_JEM_TEMPLATING=true bundle exec kettle-jem install
+```
+
+Troubleshooting Git diffs
+- Use `git diff --no-ext-diff` to compare against Git's built-in diff output.
+- Use `git diff --no-textconv` when a textconv projection obscures the raw file bytes you need to inspect.
+- If Git reports a missing `smorg-*` executable, rerun `bundle install` and the setup command above, then check `git config --local --get-regexp '^diff\.smorg-'`.
+- To remove managed local entries, run `K_JEM_TEMPLATING=true bundle exec kettle-jem install --undo`; remove global command registrations with `git config --global --unset-all diff.smorg-ruby.command`.
+
+For a quick starting point, this repository’s `mise.toml` defines the shared defaults, and `.env.local` can override them locally. Copy `.env.local.example` to `.env.local`, use `KEY=value` lines, and either activate `mise` in your shell or run commands through `mise exec -C /path/to/project -- ...`.
+
+## Appraisals
+
+From time to time the [appraisal2][🚎appraisal2] gemfiles in `gemfiles/` will need to be updated.
+Generated appraisal and CI workflow floors are controlled by `ruby.test_minimum`
+in `.structuredmerge/kettle-jem.yml`; this project was templated with `ruby.test_minimum: 3.2.0`.
+That value describes the lowest Ruby version expected to run the test/development
+toolchain, and it may be higher than the gemspec runtime floor.
+
+They are created and updated with the commands:
+
+```console
+bin/rake appraisal:update
 ```
 
+If you need to reset all gemfiles/*.gemfile.lock files:
+
+```console
+bin/rake appraisal:reset
+```
+
+When adding an appraisal to CI, check the [runner tool cache][🏃‍♂️runner-tool-cache] to see which runner to use.
+
 ## Run Tests
 
-To run all tests
+Run tests via `kettle-test` (provided by `kettle-test`). It runs RSpec, writes the full log to
+`tmp/kettle-test/rspec-TIMESTAMP.log`, and prints a compact highlight block with timing, seed,
+pass/fail count, failing example list, and SimpleCov coverage percentages.
+
+```console
+bundle exec kettle-test
+```
+
+For targeted runs, disable the hard coverage threshold to avoid false failures:
 
-```bash
-bundle exec rake test
+```console
+K_SOUP_COV_MIN_HARD=false bundle exec kettle-test spec/path/to/spec.rb
 ```
 
+### Spec organization (required)
+
+- One spec file per class/module. 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 exactly: `lib/standard/rubocop/lts/my_class.rb` -> `spec/standard/rubocop/lts/my_class_spec.rb`.
+- Exception: Integration specs that intentionally span multiple classes. Place these under `spec/integration/` (or a clearly named integration folder), and do not directly mirror a single class. Name them after the scenario, not a class.
+
 ## Lint It
 
 Run all the default tasks, which includes running the gradually autocorrecting linter, `rubocop-gradual`.
 
-```bash
+```console
 bundle exec rake
 ```
 
 Or just run the linter.
 
-```bash
+```console
 bundle exec rake rubocop_gradual:autocorrect
 ```
 
+For more detailed information about using RuboCop in this project, please see the [RUBOCOP.md](RUBOCOP.md) guide. This project uses `rubocop_gradual` instead of vanilla RuboCop, which requires specific commands for checking violations.
+
+### Important: Do not add inline RuboCop disables
+
+Never add `# rubocop:disable ...` / `# rubocop:enable ...` comments to code or specs (except when following the few existing `rubocop:disable` patterns for a rule already being disabled elsewhere in the code). Instead:
+
+- Prefer configuration-based exclusions when a rule should not apply to certain paths or files (e.g., via `.rubocop.yml`).
+- When a violation is temporary, and you plan to fix it later, record it in `.rubocop_gradual.lock` using the gradual workflow:
+  - `bundle exec rake rubocop_gradual:autocorrect` (preferred)
+  - `bundle exec rake rubocop_gradual:force_update` (only when you cannot fix the violations immediately)
+
+As a general rule, fix style issues rather than ignoring them. For example, our specs should follow RSpec conventions like using `described_class` for the class under test.
+
 ## Contributors
 
 Your picture could be here!
@@ -69,49 +204,69 @@ Also see GitLab Contributors: [https://gitlab.com/rubocop-lts/standard-rubocop-l
 
 ### One-time, Per-maintainer, Setup
 
-**IMPORTANT**: If you want to sign the build you create,
-your public key for signing gems will need to be picked up by the line in the
+**IMPORTANT**: To sign a build,
+a public key for signing gems will need to be picked up by the line in the
 `gemspec` defining the `spec.cert_chain` (check the relevant ENV variables there).
-All releases to RubyGems.org will be signed.
+All releases are signed releases.
 See: [RubyGems Security Guide][🔒️rubygems-security-guide]
 
-NOTE: To build without signing the gem you must set `SKIP_GEM_SIGNING` to some value in your environment.
+NOTE: To build without signing the gem set `SKIP_GEM_SIGNING` to any value in the environment.
 
 ### To release a new version:
 
-1. Run `bin/setup && bin/rake` as a tests, coverage, & linting sanity check
+#### Automated process
+
+1. Update version.rb to contain the correct version-to-be-released.
+2. Run `bundle exec kettle-changelog`.
+3. Run `bundle exec kettle-release`.
+4. Stay awake and monitor the release process for any errors, and answer any prompts.
+
+#### Manual process
+
+1. Run `bin/setup && bin/rake` as a "test, coverage, & linting" sanity check
 2. Update the version number in `version.rb`, and ensure `CHANGELOG.md` reflects changes
 3. Run `bin/setup && bin/rake` again as a secondary check, and to update `Gemfile.lock`
-4. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
-5. Run `git push` to trigger the final CI pipeline before release, & merge PRs
-    - NOTE: Remember to [check the build][🧪build]!
-6. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
-7. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
-8. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure you will release the latest trunk code
-9. Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use same timestamp, and generate same checksums
+4. Run `bin/rake yard` to regenerate the docs site using the canonical docs task
+5. Run `git commit -am "🔖 Prepare release v<VERSION>"` to commit the changes
+6. Run `git push` to trigger the final CI pipeline before release, and merge PRs
+    - NOTE: Remember to [check the build][🧪build].
+7. Run `export GIT_TRUNK_BRANCH_NAME="$(git remote show origin | grep 'HEAD branch' | cut -d ' ' -f5)" && echo $GIT_TRUNK_BRANCH_NAME`
+8. Run `git checkout $GIT_TRUNK_BRANCH_NAME`
+9. Run `git pull origin $GIT_TRUNK_BRANCH_NAME` to ensure latest trunk code
+10. Optional for older Bundler (< 2.7.0): Set `SOURCE_DATE_EPOCH` so `rake build` and `rake release` use the same timestamp and generate the same checksums
+    - If your Bundler is >= 2.7.0, you can skip this; builds are reproducible by default.
     - Run `export SOURCE_DATE_EPOCH=$EPOCHSECONDS && echo $SOURCE_DATE_EPOCH`
     - If the echo above has no output, then it didn't work.
-    - Note that you'll need the `zsh/datetime` module, if running `zsh`.
+    - Note: `zsh/datetime` module is needed, if running `zsh`.
     - In older versions of `bash` you can use `date +%s` instead, i.e. `export SOURCE_DATE_EPOCH=$(date +%s) && echo $SOURCE_DATE_EPOCH`
-10. Run `bundle exec rake build`
-11. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
+11. Run `bundle exec rake build`
+12. Run `bin/gem_checksums` (more context [1][🔒️rubygems-checksums-pr], [2][🔒️rubygems-guides-pr])
     to create SHA-256 and SHA-512 checksums. This functionality is provided by the `stone_checksums`
     [gem][💎stone_checksums].
-    - Checksums will be committed automatically by the script, but not pushed
-12. Run `bundle exec rake release` which will create a git tag for the version,
-    push git commits and tags, and push the `.gem` file to [rubygems.org][💎rubygems]
+    - The script automatically commits but does not push the checksums
+13. Sanity check the SHA256, comparing with the output from the `bin/gem_checksums` command:
+    - `sha256sum pkg/<gem name>-<version>.gem`
+14. Run `bundle exec rake release` which will create a git tag for the version,
+    push git commits and tags, and push the `.gem` file to the gem host configured in the gemspec.
 
-[🚎src-main]: https://gitlab.com/rubocop-lts/standard-rubocop-lts
+[📜src-gl]: https://gitlab.com/rubocop-lts/standard-rubocop-lts
+[📜src-cb]: https://codeberg.org/rubocop-lts/standard-rubocop-lts
+[📜src-gh]: https://github.com/rubocop-lts/standard-rubocop-lts
 [🧪build]: https://github.com/rubocop-lts/standard-rubocop-lts/actions
-[🤝conduct]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/blob/main/CODE_OF_CONDUCT.md
+[🤝conduct]: https://github.com/rubocop-lts/standard-rubocop-lts/blob/main/CODE_OF_CONDUCT.md
 [🖐contrib-rocks]: https://contrib.rocks
 [🖐contributors]: https://github.com/rubocop-lts/standard-rubocop-lts/graphs/contributors
 [🚎contributors-gl]: https://gitlab.com/rubocop-lts/standard-rubocop-lts/-/graphs/main
 [🖐contributors-img]: https://contrib.rocks/image?repo=rubocop-lts/standard-rubocop-lts
-[💎rubygems]: https://rubygems.org
+[💎gem-coop]: https://gem.coop
 [🔒️rubygems-security-guide]: https://guides.rubygems.org/security/#building-gems
 [🔒️rubygems-checksums-pr]: https://github.com/rubygems/rubygems/pull/6022
 [🔒️rubygems-guides-pr]: https://github.com/rubygems/guides/pull/325
-[💎stone_checksums]: https://github.com/pboling/stone_checksums
+[💎stone_checksums]: https://github.com/galtzo-floss/stone_checksums
 [📗keep-changelog]: https://keepachangelog.com/en/1.0.0/
 [📗keep-changelog-img]: https://img.shields.io/badge/keep--a--changelog-1.0.0-FFDD67.svg?style=flat
+[📌semver-breaking]: https://github.com/semver/semver/issues/716#issuecomment-869336139
+[📌major-versions-not-sacred]: https://tom.preston-werner.com/2022/05/23/major-version-numbers-are-not-sacred.html
+[🚎appraisal2]: https://github.com/appraisal-rb/appraisal2
+[🏃‍♂️runner-tool-cache]: https://github.com/ruby/ruby-builder/releases/tag/toolcache
+[✉️discord-invite]: https://discord.gg/3qme4XHNKN