Release Notes

Every notable change to One Shot is recorded in CHANGELOG.md, at the root of the repository. It's the human-readable record backing the update promise described in Pulling Kit Updates: a tagged release is what an active license actually gets you, and the changelog is where you read what that release changed before you merge it in.

What a changelog entry actually looks like

Entries group by version and date, then by kind of change (typically Added, Changed, or Fixed), and each one explains not just what changed but why, often naming the specific problem the change fixes and what would go wrong without it. That "why" matters more here than in most changelogs: a coding agent merging an update reads this file too, and an entry that only says what changed without saying why gives it nothing to reason about when a merge conflict lands on exactly that code.

Releases are git tags

A release is a git tag on the kit's delivery repository. Pulling a specific release rather than the latest main means fetching and merging (or cherry-picking) that tag specifically, which is useful if you want to review one release's changes in isolation rather than everything that's landed since your last update.

Checking before you merge

Before running git merge oneshot/main, skim the [Unreleased] section and any versions between your current base and the tip for anything marked as needing a manual step beyond bin/rails db:migrate, a renamed environment variable, a changed default, a removed file. Most entries need nothing extra; the ones that do say so explicitly.

You've reached the end of the docs

That's every category. Head back to Getting Started if you're just arriving, or to the docs index to jump anywhere else.