fix(scripts): repoint checks at the .adoc files that exist - #56
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: README.md->README.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 installer now checks for ChangesDocumentation installation
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to The change only repoints an installation check from README.md to the existing README.adoc file; no actionable merge-blocking risk remains after normal checks and review. Suggested reviewers: Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Up to standards ✅🟢 Issues
|
![codacy-production[bot]](https://avatars.githubusercontent.com/in/56611?s=60&v=4){kind=small}
There was a problem hiding this comment.
Pull Request Overview
This PR updates the install.sh script to reference README.adoc instead of README.md, ensuring compatibility with the project's migration to AsciiDoc. Codacy analysis indicates the change is up to standards. However, there is a significant discrepancy between the PR description, which claims to address 56 checks across 18 repositories, and the provided diff, which contains only one change in a single file. Furthermore, while the repointing is correct, no automated tests were included to verify the script's behavior with the new file extension.
About this PR
- There is a mismatch between the PR description and the actual changes. The description outlines a wide-scale fix across 18 repositories and 56 checks, but the diff only shows one change in
install.sh. Please verify if other changes were intended to be part of this PR. - No automated unit or integration tests were provided to verify that the script correctly handles the existence and copying of the
.adocfile. Consider adding basic verification to ensure the installation process remains robust.
Test suggestions
- Verify that README.adoc is successfully copied to the installation directory when it exists.
- Verify that the installation script does not fail if README.adoc is absent.
Prompt proposal for missing tests
Consider implementing these tests if applicable:
1. Verify that README.adoc is successfully copied to the installation directory when it exists.
2. Verify that the installation script does not fail if README.adoc is absent.
TIP Improve review quality by adding custom instructions
TIP How was this review? Give us feedback
1 participant
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: README.md->README.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.