fix(scripts): repoint checks at the .adoc files that exist - #174
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: MAINTAINERS.md->MAINTAINERS.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. (1)
🔇 Additional comments (1)
📝 WalkthroughSummary by CodeRabbit
WalkthroughThe verification script now checks ChangesMaintainers verification
Estimated code review effort: 1 (Trivial) | ~3 minutes Merge Risk: ⚪ Minimal · up to The change repoints documentation checks from nonexistent .md files to the corresponding .adoc file, with no actionable merge-blocking risk remaining after normal checks and review. 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
This PR successfully repoints the verify-rsr.sh script to reference MAINTAINERS.adoc instead of the deprecated MAINTAINERS.md. Codacy reports that the changes are up to standards.
While the implementation appears correct based on the intent, there are several missing test scenarios required to ensure the script behaves correctly with the new file format and its internal structure. Specifically, validation of grep patterns against the AsciiDoc content and failure handling for missing sections in the .adoc file should be confirmed before merging.
Test suggestions
- Execute verify-rsr.sh in a directory containing MAINTAINERS.adoc to confirm successful detection.
- Verify grep patterns for 'Perimeter 1/2/3' and 'Community Sandbox' correctly match content within the .adoc file.
- Ensure the script fails or warns appropriately when MAINTAINERS.adoc is present but missing required TPCF sections.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Execute verify-rsr.sh in a directory containing MAINTAINERS.adoc to confirm successful detection.
2. Verify grep patterns for 'Perimeter 1/2/3' and 'Community Sandbox' correctly match content within the .adoc file.
3. Ensure the script fails or warns appropriately when MAINTAINERS.adoc is present but missing required TPCF sections.
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: MAINTAINERS.md->MAINTAINERS.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.