📝 Kettle::Changelog
if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know on Discord or RubyForum, as I may have missed the notification.
if ci_badges.map(&:color).all? { it == "green"} 👇️ send money so I can do more of this. FLOSS maintenance is now my full-time job.
👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️
I've summarized my thoughts in this blog post.
🌻 Synopsis 
kettle-changelog prepares and maintains CHANGELOG.md files for Ruby gems. It moves entries from Unreleased into a versioned release section, adds coverage and documentation statistics, updates comparison links, and can emit structured release events for orchestration tools.
💡 Info you can shake a stick at
| Tokens to Remember |   |
|---|---|
| Works with MRI Ruby 4 |   |
| Support & Community |      |
| Source |     |
| Documentation |      |
| Compliance |      |
| Style |     |
| Maintainer 🎖️ |      |
... 💖 |
    🧊 🐙 🛖 🧪 |
Compatibility
Compatible with MRI Ruby 4.0.0+.
CI workflows and Appraisals are generated for MRI Ruby 4.0.0+.
This test floor is configured by ruby.test_minimum in .kettle-jem.yml and
may be higher than the gem's runtime compatibility floor when legacy Rubies are
not practical for the current toolchain.
The amazing test matrix is powered by the kettle-dev stack.
How kettle-dev manages complexity in tests
| Gem | Source | Role | Total downloads |
|---|---|---|---|
| appraisal2 | GitHub | multi-dependency Appraisal matrix generation |  |
| appraisal2-rubocop | GitHub | RuboCop Appraisal generator integration |  |
| kettle-dev | GitHub | development, release, and CI workflow tooling |  |
| kettle-jem | GitHub | Appraisals & CI workflow templates |  |
| kettle-soup-cover | GitHub | SimpleCov coverage policy and reporting |  |
| kettle-test | GitHub | standard test runner and coverage harness |  |
| rubocop-lts | GitHub | Ruby-version-aware linting |  |
| turbo_tests2 | GitHub | parallel test execution |  |
Federated DVCS
Find this repo on federated forges (Coming soon!)
| Federated DVCS Repository | Status | Issues | PRs | Wiki | CI |
|---|---|---|---|---|---|
| 🧪 kettle-dev/kettle-changelog on GitLab | The Truth | 💚 | 💚 | 💚 | 🐭 Tiny Matrix |
| 🧊 kettle-dev/kettle-changelog on CodeBerg | An Ethical Mirror (Donate) | 💚 | 💚 | ➖ | ⭕️ No Matrix |
| 🐙 kettle-dev/kettle-changelog on GitHub | Another Mirror | 💚 | 💚 | 💚 | 💯 Full Matrix |
Enterprise Support 
Available as part of the Tidelift Subscription.
Need enterprise-level guarantees?
The maintainers of this and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use.
- 💡Subscribe for support guarantees covering all your FLOSS dependencies
- 💡Tidelift is part of Sonar
- 💡Tidelift pays maintainers to maintain the software you depend on!
📊@Pointy Haired Boss: An enterprise support subscription is "never gonna let you down", and supports open source maintainers
Alternatively:
✨ Installation
Install the gem and add to the application's Gemfile by executing:
bundle add kettle-changelog
If bundler is not being used to manage dependencies, install the gem by executing:
gem install kettle-changelog
⚙️ Configuration
kettle-changelog has no project configuration file. Configure project-specific paths and release behavior with environment variables:
K_CHANGELOG_PATHselects a changelog outside the current project root.K_CHANGELOG_COVERAGE_ROOTselects the project root used for coverage generation.K_CHANGELOG_VERSION_FILEselects the version file when the project has more than one version tree.K_CHANGELOG_GEM_NAMEoverrides the gem name used for release lookups.K_CHANGELOG_STRICT=falseallows missing coverage or YARD data.K_CHANGELOG_COVERAGE_HARD=falsedisables hard coverage-threshold failures.KETTLE_GEM_COOP_REFRESH=truerefreshes cached gem metadata.
🔧 Basic Usage
Run the release preparation command from the gem root:
bundle exec kettle-changelog
Use --yes for non-interactive release automation. Add a note without preparing a release with:
bundle exec kettle-changelog --add-unreleased-entry --section Fixed --entry "Describe the fix."
Useful queries and maintenance commands include --pending-release, --release-state, --reformat, --update-prep, --json, and --events=changelog. Run bundle exec kettle-changelog --help for the complete option list.
🔐 Security
See SECURITY.md.
🤝 Contributing
If you need some ideas of where to help, you could work on adding more code coverage, check issues or PRs, or use the gem and think about how it could be better.
We so if you make changes, remember to update it.
See CONTRIBUTING.md for more detailed instructions.
🚀 Release Instructions
See CONTRIBUTING.md.
Code Coverage
Coverage service badges
🪇 Code of Conduct
Everyone interacting with this project's codebases, issue trackers,
chat rooms and mailing lists agrees to follow the .
🌈 Contributors
Made with contributors-img.
Also see GitLab Contributors: https://gitlab.com/kettle-dev/kettle-changelog/-/graphs/main
📌 Versioning
This library follows for its public API where practical.
For most applications, prefer the Pessimistic Version Constraint with two digits of precision.
For example:
spec.add_dependency("kettle-changelog", "~> 1.0")
📌 Is "Platform Support" part of the public API? More details inside.
Dropping support for a platform can be a breaking change for affected users. If a release changes supported platforms, it should be called out clearly in the changelog and versioned with that impact in mind.
To get a better understanding of how SemVer is intended to work over a project's lifetime, read this article from the creator of SemVer:
See CHANGELOG.md for a list of releases.
📄 License
The gem is available under the following license: AGPL-3.0-only. See LICENSE.md for details.
If none of the available licenses suit your use case, please contact us to discuss a custom commercial license.
© Copyright
See LICENSE.md for the official copyright notice.
Copyright holders
- Copyright (c) 2026 Peter H. Boling
🤑 A request for help
Maintainers have teeth and need to pay their dentists. After getting laid off in an RIF in March, and encountering difficulty finding a new one, I began spending most of my time building open source tools. I'm hoping to be able to pay for my kids' health insurance this month, so if you value the work I am doing, I need your support. Please consider sponsoring me or the project.
To join the community or get help, use the RubyForum or Discord.
To say "thanks!" ☝️ Join the community or 👇️ send money.
💌 
Please give the project a star ⭐ ♥.
Many parts of this project are actively managed by a kettle-jem smart template utilizing StructuredMerge.org merge contracts.
Thanks for RTFM. ☺️
| Field | Value |
|---|---|
| Package | kettle-changelog |
| Description | 📝 kettle-changelog formats release sections, manages Unreleased entries, and emits machine-readable release events for Ruby gems. |
| Homepage | https://github.com/kettle-dev/kettle-changelog |
| Source | https://github.com/kettle-dev/kettle-changelog |
| License | AGPL-3.0-only |
| Funding | https://github.com/sponsors/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/kettle-dev, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/kettle-changelog, https://www.buymeacoffee.com/pboling |