fix(scripts): repoint checks at the .adoc files that exist - #71
Conversation
The .md -> .adoc documentation migration moved these files but never updated
the scripts that READ them, so every check naming a .md has been operating on
a file that no longer exists.
Repointed: CHANGELOG.md->CHANGELOG.adoc CODE_OF_CONDUCT.md->CODE_OF_CONDUCT.adoc CONTRIBUTING.md->CONTRIBUTING.adoc MAINTAINERS.md->MAINTAINERS.adoc README.md->README.adoc SECURITY.md->SECURITY.adoc TPCF.md->TPCF.adoc
Three failure modes were in play across the estate, all fixed by the same
change:
* hard fail - 'check "X.md exists" "[ -f X.md ]"' can never pass
* wrong score - '[ -f X.md ] && ((doc_score++))' silently scores lower
* SILENT SKIP - 'if [ -f X.md ]; then ...greps... fi' skips the whole block,
so the checks inside never run and the gate reports success
by not checking at all
Human-readable labels are repointed too, so failure messages name the file that
is actually inspected. Where a script did 'git add ... X.md', that is fixed as
well - it would have failed at release time.
Only tokens whose .adoc twin exists in this repository were rewritten; anything
without a twin was left untouched for separate triage.
Found by an estate-wide sweep of 454 repos: 56 such checks across 18 repos.
Same defect class as hyperpolymath/Axiom.jl#82.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📜 Recent review details⏰ Context from checks skipped due to timeout. (2)
🔇 Additional comments (2)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe verification script now checks ChangesDocumentation verification
Estimated code review effort: 1 (Trivial) | ~5 minutes Merge Risk: ⚪ Minimal · up to This localized change updates script references from missing .md paths to existing .adoc files; no actionable merge-blocking risk remains beyond normal checks and review. Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
Full details: Docstring CoverageExplanation No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1 files. ✨ Finishing Touches📝 Generate docstrings
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Up to standards ✅🟢 Issues
|
There was a problem hiding this comment.
Pull Request Overview
The changes correctly transition the repository verification logic from Markdown to AsciiDoc, ensuring that existence and content checks target .adoc files. Codacy analysis indicates the PR is up to standards with no new quality or complexity issues. While the implementation appears to meet the acceptance criteria for updating file extensions and user-facing labels, the current lack of automated test scenarios for the modified script remains the primary observation.
Test suggestions
- Verify that rsr-verify.sh passes when documentation files exist with .adoc extensions
- Verify that rsr-verify.sh fails/warns when documentation files are missing or still using .md extensions
- Verify that TPCF content checks correctly grep 'Perimeter 1' and 'Perimeter 3' within TPCF.adoc
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify that rsr-verify.sh passes when documentation files exist with .adoc extensions
2. Verify that rsr-verify.sh fails/warns when documentation files are missing or still using .md extensions
3. Verify that TPCF content checks correctly grep 'Perimeter 1' and 'Perimeter 3' within TPCF.adoc
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
The
.md→.adocdocumentation migration moved these files but never updated the scripts that read them, so every check naming a.mdhas been operating on a file that no longer exists.Repointed: CHANGELOG.md->CHANGELOG.adoc CODE_OF_CONDUCT.md->CODE_OF_CONDUCT.adoc CONTRIBUTING.md->CONTRIBUTING.adoc MAINTAINERS.md->MAINTAINERS.adoc README.md->README.adoc SECURITY.md->SECURITY.adoc TPCF.md->TPCF.adoc
Three failure modes were in play across the estate, all fixed by the same change:
check "X.md exists" "[ -f X.md ]"[ -f X.md ] && ((doc_score++))if [ -f X.md ]; then …greps… fiLabels are repointed too, so failure messages name the file actually inspected. Where a script did
git add … X.md, that is fixed as well — it would have failed at release time.Only tokens whose
.adoctwin exists here were rewritten; anything without a twin was left for separate triage.Found by an estate-wide sweep of 454 repos: 56 such checks across 18 repos. Same class as hyperpolymath/Axiom.jl#82.