docs: RELEASING.md — the release process, written for an agent to follow#136
Merged
Conversation
Cutting a release means updating version references that must agree — the three workspace deno.json files, the VERSION constant in packages/core/mod.ts that the binaries and image workflows verify against the tag, and the action and image tags pinned throughout the docs and examples. v0.7.0 went out with only three of the four source references bumped and had to be superseded the same day, and none of this was written down anywhere. Releases here are performed by an AI agent, so the process is a document rather than a script: RELEASING.md covers picking the version, every reference pattern to rewrite, a grep to prove nothing stale survives, the ship steps, and what to do when a release goes wrong (fix forward — JSR versions are immutable). Also heals the one reference that had already drifted: docs/cli.md still pinned the 0.6.0 image. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_014wdAEgtK4rWFW45kao61km
fb1bfcc to
a3f8ad1
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
Cutting a release means updating version references that must all agree: the three workspace
deno.jsonfiles, theVERSIONconstant inpackages/core/mod.ts(which therelease-binariesandpublish-imageworkflows verify against the tag), and — since #137 — the action and image tags pinned throughout the docs and examples. v0.7.0 went out with only three of the four source references bumped: JSR published (immutably) with the stale constant while the binaries and image builds refused the tag, and v0.7.1 had to follow the same day. None of the process was written down anywhere.What
Releases in this repo are performed by an AI agent, so the process is a document rather than a script:
`@vX.Y.Z`inline code), a grep that proves no stale reference survives, the ship steps and the three workflows that must go green, and what to do when a release goes wrong (fix forward — JSR versions are immutable, never move a tag).0.6.0image.An earlier revision of this PR implemented the bump as
deno task bump; it was replaced with the document by request. The reference patterns in RELEASING.md were validated by running that script's sweep against main — it caught every reference listed and nothing else.🤖 Generated with Claude Code
https://claude.ai/code/session_014wdAEgtK4rWFW45kao61km