Skip to content

Catch stale generated docs in PR CI, not at release time - #155

Merged
DavertMik merged 1 commit into
mainfrom
fix/docs-sync-gate-in-ci
Aug 28, 2026
Merged

Catch stale generated docs in PR CI, not at release time#155
DavertMik merged 1 commit into
mainfrom
fix/docs-sync-gate-in-ci

Conversation

@DavertMik

Copy link
Copy Markdown
Contributor

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.md holds generated blocks between <!-- START/END provider:* --> markers, built from models.json. #148 added model and visionModel to the anthropic entry without running bunosh docs:sync, so the doc still advertised only agenticModel plus a "this provider doesn't serve model and visionModel" note — contradicting the config that shipped.

docs:sync --check ran only in publish.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 by tests/node/build.test.mjs.

What changed

  • Regenerated 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.
  • Added the same docs:sync --check step to test.yml after bun install, so a push or PR touching models.json or the EXPLORBOT_* env table fails there instead of at release.

The publish.yml gate 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.3 tag at the merged commit or cut 0.3.4.

🤖 Generated with Claude Code

https://claude.ai/code/session_01RXmuB8FE2dCdpZ2B7ZJzf2

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
@DavertMik
DavertMik merged commit 484f361 into main Aug 28, 2026
2 checks passed
@DavertMik
DavertMik deleted the fix/docs-sync-gate-in-ci branch August 28, 2026 09:30
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