docs: add an agent release runbook and make AGENTS.md canonical - #3
Merged
Merged
Conversation
Releases were undocumented, so each one relied on rediscovering which files carry the version and which must be left alone. docs/updating-version.md writes that down: the two files that change, the derived files that must not be hand-edited, and why nix/gemset.nix stays on the old version until CI repins it after publish. It also records why the release marker belongs in the pull request title. The master ruleset requires a PR, so the push to master is the squash commit, and GitHub builds that message from the title. A marker in a branch commit does not survive. AGENTS.md becomes the one place repo instructions live, so every coding agent reads the same source. Claude Code reads CLAUDE.md rather than AGENTS.md, so CLAUDE.md now imports it instead of restating the devenv rule and drifting from it. The Backlog.md block is dropped; this repo does not use it. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
ajmarkow
force-pushed
the
docs/agent-instructions
branch
from
September 15, 2026 17:55
b0d6f45 to
d38fad9
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
1 participant
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.
Writes down the release process and gives every coding agent one source to read.
docs/updating-version.mdReleases were undocumented, so each one meant rediscovering which files carry the version and which must be left alone. This records it:
lib/snippet_cli/version.rbandCHANGELOG.mdSnippetCli::VERSION(gemspec, theversioncommand, its spec)nix/gemset.nixandnix/Gemfile.lockare different — they pin the published gem and must stay on the old version during a release, because bundix cannot resolve a version RubyGems has not indexed. CI repins them afterwards.gemset-checkis expected to report on a release PR, and the failure modesAGENTS.mdNew, and now the canonical place for repo instructions — the devenv/Ruby rule, the Nix packaging notes including the
gumbinary patch, and the aruba test caveat where fivecli_spec.rbexamples fail in a polluted local Bundler environment but pass in CI.CLAUDE.mdClaude Code reads
CLAUDE.md, notAGENTS.md. Per the Claude Code docs, the supported bridge is an@AGENTS.mdimport, which expands at session start. That is stronger than prose telling the agent to open the file, and it keeps one source instead of two that drift.So the hand-written devenv section is gone from
CLAUDE.mdand lives inAGENTS.mdinstead. The Backlog.md block is also dropped, since this repo does not use it.Net effect:
CLAUDE.mdis the import plus the RTK block, and every agent reads the same instructions.Notes
Neither new file ships in the gem.
spec.filesonly matcheslib/,exe/, and a root README, CHANGELOG, or LICENSE.🤖 Generated with Claude Code