ci(skills): gate PRs on skill-docs being generated from SKILL.md frontmatter#1844
Merged
Conversation
…tmatter Adds a `Check Skill Docs` job to ci.yml, gated (via paths-filter) on changes to `skills/**`, `content/docs/guides/skills.mdx`, or the generator script. It runs `pnpm --filter @objectstack/spec check:skill-docs`, which fails if the README index or guide tables/cards drift from each SKILL.md frontmatter — closing the loop so the catalog can never silently go stale again. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
github-actions
Bot
added
documentation
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
2 participants
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.
Why
Follow-up to #1842, which made the skill catalog (README index +
guides/skills.mdxtables/cards) generated from eachSKILL.mdfrontmatter viabuild-skill-docs.ts. Without a CI gate, the generated files can still be hand-edited or left stale when aSKILL.mdchanges — the exact drift that caused the original fabricated-docs problem.What
Adds a
Check Skill Docsjob toci.yml:paths-filter— runs only whenskills/**,content/docs/guides/skills.mdx, orpackages/spec/scripts/build-skill-docs.tschange.pnpm --filter @objectstack/spec check:skill-docs(build-skill-docs.ts --check), which fails (exit 1) if the README/guide listings differ from what the frontmatter would generate, with a hint to rungen:skill-docs.tsx).Verification
ci.ymlvalidated as YAML.main→ passes (Skill docs in sync).ci.yml, so the new job runs on the PR itself (self-test).🤖 Generated with Claude Code