Catch stale generated docs in PR CI, not at release time - #155
Merged
Conversation
PR #148 edited models.json without running `bunosh docs:sync`, leaving the anthropic block in docs/basics/providers.md stale. The staleness gate lived only in publish.yml, so nothing went red until the 0.3.3 tag was pushed and the release job died before npm publish. Regenerate providers.md and run the same `docs:sync --check` in test.yml, so any push or PR that touches models.json or the env var table fails there. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01RXmuB8FE2dCdpZ2B7ZJzf2
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.
The 0.3.3 release job failed on Verify generated docs are up to date, before
npm publish— so 0.3.3 was never published.Why
docs/basics/providers.mdholds generated blocks between<!-- START/END provider:* -->markers, built frommodels.json. #148 addedmodelandvisionModelto theanthropicentry without runningbunosh docs:sync, so the doc still advertised onlyagenticModelplus a "this provider doesn't servemodelandvisionModel" note — contradicting the config that shipped.docs:sync --checkran only inpublish.yml.test.yml, the workflow on every push and PR, never ran it. The staleness sailed through every PR check and surfaced only once the tag was pushed. It was the one release-gate step with no PR-CI equivalent — the CLI smoke checks are already covered bytests/node/build.test.mjs.What changed
docs/basics/providers.md. Anthropic now lists all three roles and the pair-with-another-provider note is gone. That was the only stale file.docs:sync --checkstep totest.ymlafterbun install, so a push or PR touchingmodels.jsonor theEXPLORBOT_*env table fails there instead of at release.The
publish.ymlgate stays as a backstop for tags cut from commits that skipped PR CI.After merge
0.3.3 still needs to publish — either re-push the
0.3.3tag at the merged commit or cut 0.3.4.🤖 Generated with Claude Code
https://claude.ai/code/session_01RXmuB8FE2dCdpZ2B7ZJzf2