Skip to content

docs: sync to v0.5.0 and carry the cutover's evidence forward - #118

Merged
mbeacom merged 3 commits into
mainfrom
mbeacom-docs-sync-v0-5-0
Aug 11, 2026
Merged

docs: sync to v0.5.0 and carry the cutover's evidence forward#118
mbeacom merged 3 commits into
mainfrom
mbeacom-docs-sync-v0-5-0

Conversation

@mbeacom

@mbeacom mbeacom commented Aug 10, 2026

Copy link
Copy Markdown
Owner

What and why

Post-release docs sync for v0.5.0, matching the #105 pattern from v0.4.0.

The site redeploys from main, and that ran seconds after #110 merged — before any
version string had moved. So adrkit.dev has been advertising v0.4.0 while npm
serves 0.5.0
since 13:16 today. That is the urgent half of this.

Two entries needed rewriting, not a version bump

README.md still described inbound markers as reaching adr explain "and
nothing else: adr check, the Action, and the Spec Kit context script do not scan
markers, so no CI semantics move."
ADR-0022 reversed exactly that. The bullet now
describes the shipped scope, names ADR-0023's format rule, and states the
no-exit-code-authority property that makes the CI reach safe. It also credits all
three pull requests rather than only the first — @aballiet for #97 and #106,
@davesheffer for #109.

CLAUDE.md was headed "(v0.4.0 explain; check/CI extension proposed)"
and said "This branch proposes ADR-0022." #106 updated the body but not the
frame, and ADR-0023 landed afterward. Now says v0.5.0 shipped it, and points
readers at 0022 rather than the superseded 0021.

Things that moved and are easy to miss

  • ci.mdx:79 named the commit v0 peels to (c3dff3a). That tag moved with
    the release; it is now c6bceac. Verified against git rev-list -n1 v0.
  • DISTRIBUTION.md P1/P2 stated the MCP registry prerequisites as satisfied
    at 0.4.0. Re-stated against the published 0.5.0 package, and checked rather
    than assumed: npm view @adrkit/mcp@0.5.0 version0.5.0, and
    npm view @adrkit/mcp@0.5.0 mcpNamedev.adrkit/mcp. P2 is the one that
    failed at 0.2.0, because the registry reads mcpName from the published
    version rather than the working tree.
  • RELEASING.md:12,17 told the next release that v0.4.0 was current and the
    immutable Action tag.

Evidence carried forward

RELEASING.md gains this cutover's two lessons, in the section that already
collects them:

  • The publish dry-run skips the idempotency check, so it tries to republish a released adapter #104's dry-run failure is confirmed dry-run-only. Before tagging, the
    existing claim ("the real run skips the adapter") was checked instead of
    trusted: the registry's dist.shasum for @adrkit/spec-kit@0.1.2 was compared
    against the shasum the dry run had just packed. Exact match, integrity too. The
    real run then skipped the adapter and published only the four lockstep packages.
    The note records npm view <pkg>@<version> dist.shasum as the cheap way to turn
    "should skip" into "will skip" before tagging.
  • The MCP registry has no step in release.yml. dev.adrkit/mcp keeps
    serving the previous version until a human publishes, which is how it is
    currently at 0.4.0 with 0.5.0 on npm. The note names the three prerequisites to
    re-check against the published package.

Also updated the git status-after-pack line to record that it was clean for
v0.5.0 as well.

Deliberately not in this PR

DISTRIBUTION.md §A submission status is untouched. It records a verified
outcome with dates and a registry response, so it gets written after the
registry publish, not in anticipation of it. The live registry currently returns:

dev.adrkit/mcp -> 0.2.1, 0.3.0, 0.4.0

Once mcp-publisher publish has run for 0.5.0, §A needs the re-publication date
and the verified response appended. Happy to do that as a one-line follow-up.

Verification

  • bun run adr lint23 records, 0 errors, 0 warnings
  • bun run --cwd site build33 pages built, and site/dist/index.html
    renders v0.5.0 on npm
  • adr check README.md CLAUDE.md docs/RELEASING.md docs/DISTRIBUTION.md — clean,
    and notably no phantom marker declarations from the @adr references in
    these files' own prose and fenced examples, which is ADR-0023 doing its job on
    the repository that documents it

Note site/ needed its own bun install for the build; yaml was missing from
site/node_modules. That is a pre-existing local-setup detail, not something this
PR changes.

The site redeployed from main seconds after the release merge, so adrkit.dev
has been advertising v0.4.0 while npm serves 0.5.0. This closes that, and the
same staleness in the README, RELEASING, and DISTRIBUTION.

Two entries needed rewriting rather than a version bump. The README still
described markers as reaching `adr explain` "and nothing else", which
ADR-0022 reversed, and CLAUDE.md still headed the section "check/CI extension
proposed" — both now describe the shipped v0.5.0 scope, name ADR-0023's
format rule, and credit @aballiet and @davesheffer for the three pull
requests behind it.

`ci.mdx` named the commit `v0` peels to, which moved with the tag, and
DISTRIBUTION's P1/P2 prerequisites are re-stated against the published 0.5.0
package rather than 0.4.0 — both verified against npm and the tag, not
assumed.

RELEASING gains two notes from this cutover: that #104's dry-run failure was
confirmed dry-run-only by comparing the packed shasum to the registry's
before tagging, and that the MCP registry has no step in release.yml, so
`dev.adrkit/mcp` keeps serving the previous version until a human publishes.

DISTRIBUTION's §A submission record is deliberately untouched. It states a
verified outcome with a date, so it is written after the registry publish,
not before.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Mark Beacom <m@beacom.dev>
Copilot AI balanced review requested due to automatic review settings August 10, 2026 15:57

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Synchronizes documentation and website content with the v0.5.0 release and records release evidence.

Changes:

  • Updates published-version and Action-tag references.
  • Documents expanded inbound-marker behavior.
  • Records v0.5.0 release and registry lessons.

Reviewed changes

Copilot reviewed 8 out of 8 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
README.md Updates release status and marker scope.
CLAUDE.md Documents shipped marker behavior.
docs/RELEASING.md Adds v0.5.0 release evidence.
docs/DISTRIBUTION.md Updates package prerequisites and tag SHA.
site/src/components/Hero.astro Updates the homepage version.
site/src/content/docs/index.mdx Updates the status band.
site/src/content/docs/quickstart.mdx Updates the npm release callout.
site/src/content/docs/ci.mdx Updates Action pinning guidance.

💡 Add a code-review agent skill for context-aware, tailored reviews. Learn more in the docs.

Comment thread README.md Outdated
driven through the official MCP Inspector
([ADR-0018](docs/adr/0018-adopt-mcp-sdk-v2-and-serve-protocol-revision-2026-07-28-dual-era.md)).
- **New in v0.4.0, and at rung 1 only.** A file can declare the decision it
- **New in v0.5.0, and at rung 1 only.** A file can declare the decision it
Comment thread README.md Outdated
Comment on lines +243 to +244
Markers add governance context and findings; they never gain exit-code
authority, so nothing a pull request writes can fail a check.
Two review findings on #118, both accepted.

The bullet said "New in v0.5.0", which dates the whole inbound-marker feature
to this release. Markers shipped in v0.4.0 for `adr explain` under ADR-0021;
v0.5.0 extended them to check and CI and narrowed the grammar. Now says
"Expanded", and names which release did which — the same class of mistake as
the CHANGELOG claiming ADR-0021 stood unedited.

The bullet also said markers gain no exit-code authority "so nothing a pull
request writes can fail a check". The second clause does not follow and is
false: `checkChanges` sets `ok` from `error` findings on changed ADR records,
so a pull request that breaks a record it edits does fail, by design. The
limit belongs to markers, not to authored content, and the check's actual
purpose is now stated rather than contradicted.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Mark Beacom <m@beacom.dev>
@mbeacom

mbeacom commented Aug 11, 2026

Copy link
Copy Markdown
Owner Author

Both review comments accepted and fixed in b9192ba — they were the same class of defect this repo cares most about, documentation asserting something untrue.

README.md:234 — misdated the feature. Correct catch. "New in v0.5.0" dates the whole inbound-marker feature to this release, when v0.4.0 shipped it for adr explain under ADR-0021 and v0.5.0 extended it to check/CI and narrowed the grammar. Now reads "Expanded in v0.5.0" and says which release did which. This is the same mistake I flagged during the release PR, where the CHANGELOG claimed ADR-0021 "stands unedited" after ratification had moved its status and supersededBy — rewriting release history in a project whose subject is decision memory.

README.md:244 — overstated the guarantee. Also correct, and the worse of the two. I wrote that markers gain no exit-code authority "so nothing a pull request writes can fail a check." The second clause does not follow from the first and is false. checkChanges computes ok from error findings on changed ADR records:

const ok = !changedRecordFindings.some((finding) => finding.severity === 'error');

so a pull request that breaks a record it edits does fail, by design. The limit belongs to marker-derived information, not to authored content generally. Left as written, the README would have told readers adr check never fails on pull-request content — the opposite of its purpose. It now states the marker limit precisely and says what the check does fail on.

I also checked whether CLAUDE.md carried the same overbroad claim, since it has a parallel sentence. It does not — "Markers add governance context and findings but never gain exit-code authority" is already scoped to markers, so no change there.

Held back from the sync commit on purpose: §A is an evidence record with
dates and a verified registry response, so it is written after the publish
rather than in anticipation of it.

Queried the live registry rather than assuming the publish landed. It returns
four records for dev.adrkit/mcp, with 0.5.0 as the only isLatest:

  0.2.1  active  isLatest=False  2026-07-28T13:22:42Z
  0.3.0  active  isLatest=False  2026-07-31T10:54:25Z
  0.4.0  active  isLatest=False  2026-08-08T23:16:38Z
  0.5.0  active  isLatest=True   2026-08-10T16:20:32Z

§A4's verified-response table now carries the 0.5.0 record and its actual
publishedAt. The §A5 transcript of the committed server.json is re-synced to
the manifest it quotes, both version fields checked against
packages/mcp/server.json rather than edited in place. The submission-status
header, the §A status line, and the two prerequisite statements move to
0.5.0; every other 0.4.0 mention is a dated historical claim and stays.

Also records that nothing in release.yml performs this step, so the registry
keeps serving the previous version until a human publishes — which is why it
sat at 0.4.0 while npm served 0.5.0.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Signed-off-by: Mark Beacom <m@beacom.dev>
@mbeacom
mbeacom merged commit 9c7a3fd into main Aug 11, 2026
10 checks passed
@mbeacom
mbeacom deleted the mbeacom-docs-sync-v0-5-0 branch August 11, 2026 00:36
@mbeacom mbeacom self-assigned this Aug 11, 2026
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.

2 participants