ci: add skill reference doc consistency check#31
Merged
Conversation
Verifies every references/*.md file in a skill directory is listed in the skill's SKILL.md, docs/modules/ROOT/pages/skills.adoc, and README.md (and vice versa), so a future PR can't add or remove a reference doc and forget one of the listing locations. Also fixes a pre-existing gap: reqstool-overview.md was listed in SKILL.md but missing from skills.adoc and README.md. Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
- cd to repo root so the script works regardless of invocation directory - extract a shared check_reverse helper to deduplicate the two reverse-check loops - document the format conventions each grep/regex depends on, and the intentional scope (entry-point docs like reqstool-conventions.md are not cross-checked, since their link format isn't standardized) - add a CI step that proves the check fails on an undocumented reference doc, using a throwaway fixture file Signed-off-by: Jimisola Laursen <jimisola@jimisola.com>
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
1 participant
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
.github/scripts/check-skill-reference-docs.sh, run fromvalidate-plugins.yml, that fails if a skill'sreferences/*.mdfile isn't listed in itsSKILL.md,docs/modules/ROOT/pages/skills.adoc, andREADME.md— or vice versa (stale entries pointing at files that no longer exist).reqstool-overview.mdwas listed inSKILL.mdbut missing fromskills.adocandREADME.md.Closes #30
Test plan
bash .github/scripts/check-skill-reference-docs.shexits 0 with "All skill reference docs are consistently listed."reqstool-overview.mdentries are reverted (pre-fix state)claude plugin validate .passes