Skip to content

docs: RELEASING.md — the release process, written for an agent to follow#136

Merged
RatulMaharaj merged 1 commit into
mainfrom
chore/bump-version-script
Jul 13, 2026
Merged

docs: RELEASING.md — the release process, written for an agent to follow#136
RatulMaharaj merged 1 commit into
mainfrom
chore/bump-version-script

Conversation

@RatulMaharaj

@RatulMaharaj RatulMaharaj commented Jul 13, 2026

Copy link
Copy Markdown
Member

Why

Cutting a release means updating version references that must all agree: the three workspace deno.json files, the VERSION constant in packages/core/mod.ts (which the release-binaries and publish-image workflows 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:

  • RELEASING.md — the whole process, written to be followed end to end: picking the version under 0.x rules, the four source files that must agree, the doc/example reference patterns to rewrite (action tag, image tag, bare `@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).
  • CONTRIBUTING.md gets a short Releasing section pointing at it.
  • docs/cli.md — heals the one reference that had already drifted: the docker example still pinned the 0.6.0 image.

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

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
@RatulMaharaj RatulMaharaj force-pushed the chore/bump-version-script branch from fb1bfcc to a3f8ad1 Compare July 13, 2026 13:02
@RatulMaharaj RatulMaharaj changed the title chore: deno task bump keeps every version reference in sync docs: RELEASING.md — the release process, written for an agent to follow Jul 13, 2026
@RatulMaharaj RatulMaharaj merged commit df36849 into main Jul 13, 2026
1 check passed
@RatulMaharaj RatulMaharaj deleted the chore/bump-version-script branch July 13, 2026 13:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant