Repository navigation
Fix stale docs, CI comment, and changelog - #1
Merged
Merged
Conversation
Claude Code now reads AGENTS.md natively, so "reads CLAUDE.md, not
AGENTS.md" was false. The @AGENTS.md import step stays: native reading
only applies when no CLAUDE.md or CLAUDE.local.md exists.
Agent-Context: {"why":"Checked against Anthropic's memory docs rather than secondary articles: native AGENTS.md reading needs v2.1.277+, is skipped whenever any CLAUDE.md or CLAUDE.local.md exists, and was off before v2.1.281 in some sessions (Bedrock, telemetry disabled). Dropping the import step would silently stop Claude Code reading the block in any repo that has or later adds a CLAUDE.md, so init's behavior is unchanged and only the explanation was rewritten.","touches":["README.md"]}
Only init reads the block's version marker; check inspects commit
trailers and never looks at AGENTS.md.
Agent-Context: {"why":"Verified in cli/src: the format-version marker is only parsed in init.ts; check.ts has no notion of it. The claim had also been repeated when planning the 0.3 format bump, so correcting it here keeps that plan honest: init --update is the one path that notices and replaces an old block.","touches":["README.md"]}
The comment said the CLI wasn't on npm yet. It is; building from
source is still correct because this repo should check its own
unreleased code.
Agent-Context: {"why":"Considered switching the step to npx agent-commit@latest now that 0.1.0 is published, rejected because it would run the previous release against every push, so a regression in check itself would never show up in this repo's own CI.","touches":[".github/workflows/agent-commit-check.yml"]}
Everything listed under Unreleased went out in the 0.1.0 npm publish,
so it now has its own dated section, plus Keep a Changelog compare
links.
Agent-Context: {"why":"npm records the published commit (gitHead 3437716), and git log 3437716..main touches only README.md, so every Unreleased entry predates the publish and none had to be split out. The compare links point at v0.1.0, tagged locally on 3437716 in the same pass; they 404 until that tag is pushed.","touches":["CHANGELOG.md"]}
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.
Summary
Corrects claims that stopped being true, and files the changelog under the release that actually shipped.
@AGENTS.mdimport step stays, because without it, any repo that has or later adds a CLAUDE.md would stop loading the block.init's behavior is unchanged.check: removed the claim thatcheckdetects a stale AGENTS.md block. Onlyinitreads the version marker.[0.1.0]section. npm's recordedgitHeadfor 0.1.0 is3437716, and nothing after it touchedcli/or the changelog. Tagv0.1.0now points at that commit.Test plan
npm testpasses at every commit (126)npm run sync-docs:checkpassesagent-commit check --range main..docs/stale-fixes: all OKMerge with Rebase and merge so each commit's Agent-Context trailer lands on main intact.