feat(ci): automate asset docs governance with completeness and region-sync validation#2480
feat(ci): automate asset docs governance with completeness and region-sync validation#2480jkim323 wants to merge 14 commits into
Conversation
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.OpenSSF Scorecard
Scanned Files
|
Eval Execution✅ Status: Passed
No changed AI artifacts required evaluation. |
katriendg
left a comment
There was a problem hiding this comment.
Approving. The line-ending normalization in Validate-AssetDocs.ps1 is a clean, well-motivated fix — it normalizes both sides of the generated-region comparison so Windows/autocrlf checkouts no longer report false CRLF drift, and the adjacent tamper test confirms real drift detection is unaffected. New CRLF Pester test passes (41/41 locally), and the asset-docs.md contributor guide is thorough with all command and cross-link references resolving. Two optional non-blocking nits left inline (a lone-CR test case and an ms.date freshness note) — neither blocks merge.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #2480 +/- ##
==========================================
- Coverage 82.76% 82.74% -0.02%
==========================================
Files 154 154
Lines 20853 20838 -15
Branches 13 13
==========================================
- Hits 17259 17243 -16
- Misses 3592 3593 +1
Partials 2 2
Flags with carried forward coverage won't be shown. Click here to find out more.
🚀 New features to boost your workflow:
|
|
@katriendg / @rezatnoMsirhC another set of eyes would be appreciated ty! |
Pull Request
Description
Automates governance of the AI asset documentation catalog so that every agent, prompt, instruction, and skill stays documented and in sync with its generated reference page.
Key changes:
scripts/linting/Validate-AssetDocs.ps1with completeness and region-sync checks, backed by helper additions inscripts/linting/Modules/LintingHelpers.psm1and new Pester coverage.asset-docs-validation.ymlworkflow and gates pull requests on it throughpr-validation.yml, so incomplete or drifted asset docs fail the PR.docs/reference/**asset reference catalog: adds subagent reference pages (for examplehve-artifact-*,accessibility-surface-inventory,rpi-walkthrough), renamesprompt-updatertohve-artifact-explorerand related pages, and refreshes README counts.package.jsonscript/flag update supporting the validation run.Related Issue(s)
Closes #2338
Closes #2336
Type of Change
Select all that apply:
Code & Documentation:
Infrastructure & Configuration:
package.jsonchange is a build flag, not a dependency bump)AI Artifacts:
prompt-builderagent and addressed all feedback.github/instructions/*.instructions.md).github/prompts/*.prompt.md).github/agents/*.agent.md).github/skills/*/SKILL.md).github/hooks/*/*.json)evals/)Other:
.ps1,.sh,.py)Testing
Automated validation relevant to this change:
scripts/tests/linting/Validate-AssetDocs.Tests.ps1(+112) andscripts/tests/linting/LintingHelpers.Tests.ps1(+37) exercise the new completeness and region-sync logic.Checklist
Required Checks
AI Artifact Contributions
/prompt-analyzeto review contributionprompt-builderreviewRequired Automated Checks
The following validation commands must pass before merging:
npm run lint:mdnpm run spell-checknpm run lint:frontmatternpm run validate:skillsnpm run lint:md-linksnpm run lint:psnpm run eval:lint:schemanpm run plugin:generatenpm run docs:testSecurity Considerations
Additional Notes