kettle-dev Logo by Aboling0, CC BY-SA 4.0

👩‍👩‍👧‍👧 Kettle::Family

Version GitHub tag (latest SemVer) License: AGPL-3.0-only Downloads Rank CodeCov Test Coverage Coveralls Test Coverage QLTY Test Coverage QLTY Maintainability CI Heads CI Runtime Dependencies @ HEAD CI Current CI Truffle Ruby CI JRuby Deps Locked Deps Unlocked CI Test Coverage CI Style

if ci_badges.map(&:color).detect { it != "green"} ☝️ let me know, as I may have missed the discord 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.

OpenCollective Backers OpenCollective Sponsors Sponsor Me on Github Liberapay Goal Progress Donate on PayPal Buy me a coffee Donate on Polar Donate at ko-fi.com

👣 How will this project approach the September 2025 hostile takeover of RubyGems? 🚑️ I've summarized my thoughts in [this blog post](https://dev.to/galtzo/hostile-takeover-of-rubygems-my-thoughts-5hlo).

🌻 Synopsis Galtzo FLOSS Logo by Aboling0, CC BY-SA 4.0 ruby-lang Logo, Yukihiro Matsumoto, Ruby Visual Identity Team, CC BY-SA 2.5

kettle-family coordinates repeated maintenance workflows across related Ruby gems. It can discover member gems, order them by dependency or explicit hints, run shared check/test/lint/docs/template workflows, bump aligned versions, and drive release preparation or publishing.

Families can be monorepos, sibling repository workspaces, or a single flat gem that releases from several long-lived branches. For branch-stacked gems, release.target_branches lists the branches to process; the release workflow checks each branch out sequentially, rediscovers that branch's gem metadata, and runs the normal flat-repo release flow.

Publish runs are resumable. Before invoking kettle-release, kettle-family checks whether the current gem/version is already published and skips it when it is, avoiding duplicate release-prep commits after a failure/fix/retry cycle. kettle-release runs its own kettle-pre-release gate for full publish flows; options such as start_step=N and --local-ci pass through, CI failures still abort by default, and gem signing passphrases are cached once per family run while RubyGems MFA prompts remain interactive.

💡 Info you can shake a stick at

Tokens to Remember Gem name Gem namespace
Works with JRuby JRuby current Compat JRuby HEAD Compat
Works with Truffle Ruby Truffle Ruby 24.2 Compat Truffle Ruby 25.0 Compat Truffle Ruby current Compat
Works with MRI Ruby 4 Ruby 4.0 Compat Ruby current Compat Ruby HEAD Compat
Works with MRI Ruby 3 Ruby 3.2 Compat Ruby 3.3 Compat Ruby 3.4 Compat
Support & Community Join Me on Daily.dev's RubyFriends Live Chat on Discord Get help from me on Upwork Get help from me on Codementor
Source Source on GitLab.com Source on CodeBerg.org Source on Github.com The best SHA: dQw4w9WgXcQ!
Documentation Current release on RubyDoc.info YARD on Galtzo.com Maintainer Blog GitLab Wiki GitHub Wiki
Compliance License: AGPL-3.0-only Apache license compatibility: Category X 📄ilo-declaration-img Security Policy Contributor Covenant 2.1 SemVer 2.0.0
Style Enforced Code Style Linter Keep-A-Changelog 1.0.0 Gitmoji Commits Compatibility appraised by: appraisal2
Maintainer 🎖️ Follow Me on LinkedIn Follow Me on Ruby.Social Follow Me on Bluesky Contact Maintainer My technical writing
... 💖 Find Me on WellFound: Find Me on CrunchBase My LinkTree More About Me 🧊 🐙 🛖 🧪

Compatibility

Compatible with MRI Ruby 3.2.0+, and concordant releases of JRuby, and TruffleRuby. CI workflows and Appraisals are generated for MRI Ruby 3.2.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.

🚚 Amazing test matrix was brought to you by 🔎 appraisal2 🔎 and the color 💚 green 💚
👟 Check it out! github.com/appraisal-rb/appraisal2

Federated DVCS

Find this repo on federated forges (Coming soon!) | Federated [DVCS][💎d-in-dvcs] Repository | Status | Issues | PRs | Wiki | CI | Discussions | |-------------------------------------------------|-----------------------------------------------------------------------|---------------------------|--------------------------|---------------------------|--------------------------|------------------------------| | 🧪 [kettle-dev/kettle-family on GitLab][📜src-gl] | The Truth | [💚][🤝gl-issues] | [💚][🤝gl-pulls] | [💚][📜gl-wiki] | 🐭 Tiny Matrix | ➖ | | 🧊 [kettle-dev/kettle-family on CodeBerg][📜src-cb] | An Ethical Mirror ([Donate][🤝cb-donate]) | [💚][🤝cb-issues] | [💚][🤝cb-pulls] | ➖ | ⭕️ No Matrix | ➖ | | 🐙 [kettle-dev/kettle-family on GitHub][📜src-gh] | Another Mirror | [💚][🤝gh-issues] | [💚][🤝gh-pulls] | [💚][📜gh-wiki] | 💯 Full Matrix | [💚][gh-discussions] | | 🎮️ [Discord Server][✉️discord-invite] | [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] | [Let's][✉️discord-invite] | [talk][✉️discord-invite] | [about][✉️discord-invite] | [this][✉️discord-invite] | [library!][✉️discord-invite] |

Enterprise Support Tidelift

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. [![Get help from me on Tidelift][🏙️entsup-tidelift-img]][🏙️entsup-tidelift] - 💡Subscribe for support guarantees covering _all_ your FLOSS dependencies - 💡Tidelift is part of [Sonar][🏙️entsup-tidelift-sonar] - 💡Tidelift pays maintainers to maintain the software you depend on!
📊`@`Pointy Haired Boss: An [enterprise support][🏙️entsup-tidelift] subscription is "[never gonna let you down][🧮kloc]", and *supports* open source maintainers Alternatively: - [![Live Chat on Discord][✉️discord-invite-img-ftb]][✉️discord-invite] - [![Get help from me on Upwork][👨🏼‍🏫expsup-upwork-img]][👨🏼‍🏫expsup-upwork] - [![Get help from me on Codementor][👨🏼‍🏫expsup-codementor-img]][👨🏼‍🏫expsup-codementor]

✨ Installation

Install the gem and add to the application's Gemfile by executing:

bundle add kettle-family

If bundler is not being used to manage dependencies, install the gem by executing:

gem install kettle-family

⚙️ Configuration

kettle-family reads .kettle-family.yml from the family root by default. Use --config PATH to load a different file.

Member discovery is recursive under the configured member roots. Discovery skips gemspecs ignored by git and any configured members.exclude glob patterns before loading gemspec metadata, so fixture or temporary gemspecs do not create duplicate members. Exclude patterns are matched relative to the family root and to each member root.

family:
  members_root: gems

members:
  exclude:
    - "**/tmp/**"
    - "**/vendor/**"

For a flat repository that releases from multiple long-lived branches, list the release branches under release.target_branches. The branch list is processed in order. Each branch must be clean enough for git checkout, and each branch is treated as a normal flat gem after checkout.

release:
  target_branches:
    - r1_8-even-v0
    - r1_9-even-v2
    - r2_0-even-v4

Publish runs use bundle exec kettle-release by default, which means full publish flows inherit the kettle-pre-release gate from kettle-release. The release command can be overridden when a family needs a custom wrapper:

release:
  publish_command: bundle exec kettle-release

Resume and security-release options pass through to kettle-release. Passing --start-step N appends start_step=N; as with direct kettle-release usage, N > 1 resumes after the pre-release gate and should be used only after that gate already passed or the failure was intentionally handled:

kettle-family release --publish --start-step 10 --local-ci

Executed publish runs skip versions that are already published. CI failures abort by default; pass --continue-ci-failures to set K_RELEASE_CI_CONTINUE=true for the underlying kettle-release process.

🔧 Basic Usage

Inspect discovery and release plans before executing them:

kettle-family discover
kettle-family release

Audit changelog release state across the selected family members:

kettle-family release-state

The release-state report lists each gem's current version.rb, latest published release, latest versioned CHANGELOG.md section, and whether pending changelog work exists in either Unreleased or an unpublished prepared release section.

Run release prep/build phases without publishing:

kettle-family release --execute

Publish through kettle-release. A full publish first runs the kettle-pre-release gate, then prompts once for the gem signing key password and leaves RubyGems MFA prompts interactive:

kettle-family release --publish --execute

Resume a failed family publish after fixing the failure. Already published versions are skipped automatically; start_step is passed to kettle-release for unreleased members that still need work. Use --start-step only after the pre-release gate already passed or the failure was intentionally handled:

kettle-family release --publish --execute --start-step 10

For security updates, publish locally before pushing commits/tags to remotes by passing --local-ci through to kettle-release:

kettle-family release --publish --execute --local-ci

If you intentionally need to continue after CI failures, opt in explicitly:

kettle-family release --publish --execute --continue-ci-failures

🔐 Security

See SECURITY.md.

🤝 Contributing

If you need some ideas of where to help, you could work on adding more code coverage, or if it is already 💯 (see below) check issues or PRs, or use the gem and think about how it could be better.

We Keep A Changelog 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 [![Coverage Graph][🏀codecov-g]][🏀codecov] [![Coveralls Test Coverage][🏀coveralls-img]][🏀coveralls] [![QLTY Test Coverage][🏀qlty-covi]][🏀qlty-cov]

🪇 Code of Conduct

Everyone interacting with this project's codebases, issue trackers, chat rooms and mailing lists agrees to follow the Contributor Covenant 2.1.

🌈 Contributors

Contributors

Made with contributors-img.

Also see GitLab Contributors: https://gitlab.com/kettle-dev/kettle-family/-/graphs/main

⭐️ Star History Star History Chart

📌 Versioning

This library follows Semantic Versioning 2.0.0 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-family", "~> 0.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: - ["Major Version Numbers are Not Sacred"][📌major-versions-not-sacred]

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.

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 👇️ Join the Discord.

Live Chat on Discord

To say "thanks!" ☝️ Join the Discord or 👇️ send money.

Sponsor kettle-dev/kettle-family on Open Source Collective 💌 Sponsor me on GitHub Sponsors 💌 Sponsor me on Liberapay 💌 Donate on PayPal

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-family
Description 👩‍👩‍👧‍👧 Kettle::Family provides scripts and conventions for coordinating related Ruby gems as one family.
Homepage https://github.com/kettle-dev/kettle-family
Source https://github.com/kettle-dev/kettle-family/tree/v0.1.3
License AGPL-3.0-only
Funding https://github.com/sponsors/pboling, https://issuehunt.io/u/pboling, https://ko-fi.com/pboling, https://liberapay.com/pboling/donate, https://opencollective.com/kettle-dev, https://opencollective.com/kettle-rb, https://patreon.com/galtzo, https://polar.sh/pboling, https://thanks.dev/u/gh/pboling, https://tidelift.com/funding/github/rubygems/kettle-family, https://www.buymeacoffee.com/pboling