From 3595fcc3dd873fa78be125ee80e4acbd78016062 Mon Sep 17 00:00:00 2001 From: "Jonathan D.A. Jewell" <6759885+hyperpolymath@users.noreply.github.com> Date: Wed, 26 Aug 2026 16:51:52 +0100 Subject: [PATCH 1/2] fix(scripts): repoint checks at the .adoc files that exist 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 docs/PLUGIN_DEVELOPMENT.md->docs/PLUGIN_DEVELOPMENT.adoc docs/QUICKSTART.md->docs/QUICKSTART.adoc docs/TPCF.md->docs/TPCF.adoc MAINTAINERS.md->MAINTAINERS.adoc PROJECT_SUMMARY.md->PROJECT_SUMMARY.adoc README.md->README.adoc SECURITY.md->SECURITY.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. --- scripts/release.sh | 4 ++-- scripts/verify-rsr.sh | 26 +++++++++++++------------- 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/scripts/release.sh b/scripts/release.sh index 06930a0..5f80ce0 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -35,7 +35,7 @@ sed -i.bak "s/^version = \".*\"/version = \"${VERSION}\"/" Cargo.toml rm Cargo.toml.bak # Update CHANGELOG -echo -e "${YELLOW}Update CHANGELOG.md manually, then press Enter to continue...${NC}" +echo -e "${YELLOW}Update CHANGELOG.adoc manually, then press Enter to continue...${NC}" read # Build release @@ -44,7 +44,7 @@ cargo build --release # Create git tag echo -e "${YELLOW}Creating git tag v${VERSION}...${NC}" -git add Cargo.toml CHANGELOG.md +git add Cargo.toml CHANGELOG.adoc git commit -m "chore: Release v${VERSION}" git tag -a "v${VERSION}" -m "Release v${VERSION}" diff --git a/scripts/verify-rsr.sh b/scripts/verify-rsr.sh index fff8c89..5593ed9 100755 --- a/scripts/verify-rsr.sh +++ b/scripts/verify-rsr.sh @@ -65,17 +65,17 @@ echo "" echo "📡 RSR Category 3: Offline-First" check "No network dependencies in core" "[ -f Cargo.toml ]" check "Works air-gapped" "[ -f Cargo.lock ]" -check "Local-first design" "grep -qi 'offline\\|local\\|air-gapped' README.md" +check "Local-first design" "grep -qi 'offline\\|local\\|air-gapped' README.adoc" echo "" echo "📚 RSR Category 4: Documentation" -check "README.md exists" "[ -f README.md ]" +check "README.adoc exists" "[ -f README.adoc ]" check "LICENSE files exist (triple licensed)" "[ -f LICENSE-MIT ] && [ -f LICENSE-APACHE ] && [ -f LICENSE-PALIMPSEST ]" -check "CHANGELOG.md exists" "[ -f CHANGELOG.md ]" -check "CONTRIBUTING.md exists" "[ -f CONTRIBUTING.md ]" -check "CODE_OF_CONDUCT.md exists" "[ -f CODE_OF_CONDUCT.md ]" -check "SECURITY.md exists" "[ -f SECURITY.md ]" -check "MAINTAINERS.md exists" "[ -f MAINTAINERS.md ]" +check "CHANGELOG.adoc exists" "[ -f CHANGELOG.adoc ]" +check "CONTRIBUTING.adoc exists" "[ -f CONTRIBUTING.adoc ]" +check "CODE_OF_CONDUCT.adoc exists" "[ -f CODE_OF_CONDUCT.adoc ]" +check "SECURITY.adoc exists" "[ -f SECURITY.adoc ]" +check "MAINTAINERS.adoc exists" "[ -f MAINTAINERS.adoc ]" echo "" echo "🌐 RSR Category 5: .well-known/" @@ -103,9 +103,9 @@ warn "Benchmarks" "[ -f benches/scanner_benchmark.rs ]" echo "" echo "🤝 RSR Category 8: TPCF (Tri-Perimeter Contribution Framework)" -check "TPCF documented" "[ -f docs/TPCF.md ]" -check "Perimeter 3 (Community Sandbox) open" "grep -q 'Community Sandbox' docs/TPCF.md" -check "Contribution guidelines clear" "grep -q 'TPCF\|perimeter' CONTRIBUTING.md || grep -q 'contribution' CONTRIBUTING.md" +check "TPCF documented" "[ -f docs/TPCF.adoc ]" +check "Perimeter 3 (Community Sandbox) open" "grep -q 'Community Sandbox' docs/TPCF.adoc" +check "Contribution guidelines clear" "grep -q 'TPCF\|perimeter' CONTRIBUTING.adoc || grep -q 'contribution' CONTRIBUTING.adoc" echo "" echo "🔍 RSR Category 9: Code Quality" @@ -129,9 +129,9 @@ warn "Shell completions" "[ -d completions ] || [ -d contrib/completions ] || tr echo "" echo "🎯 Additional RSR Best Practices" -warn "Project summary documentation" "[ -f PROJECT_SUMMARY.md ]" -warn "Quickstart guide" "[ -f docs/QUICKSTART.md ]" -warn "Plugin development guide" "[ -f docs/PLUGIN_DEVELOPMENT.md ]" +warn "Project summary documentation" "[ -f PROJECT_SUMMARY.adoc ]" +warn "Quickstart guide" "[ -f docs/QUICKSTART.adoc ]" +warn "Plugin development guide" "[ -f docs/PLUGIN_DEVELOPMENT.adoc ]" warn "Example configurations" "[ -d examples ] && ls examples/*.toml 1>/dev/null 2>&1" warn "Automated releases" "[ -f .github/workflows/release.yml ]" echo "" From eefc9980d61e54ee4f62c4aa6db328c57934e24d Mon Sep 17 00:00:00 2001 From: "Jonathan D.A. Jewell" <6759885+hyperpolymath@users.noreply.github.com> Date: Wed, 26 Aug 2026 17:17:22 +0100 Subject: [PATCH 2/2] Update scripts/release.sh Co-authored-by: codacy-production[bot] <61871480+codacy-production[bot]@users.noreply.github.com> Signed-off-by: Jonathan D.A. Jewell <6759885+hyperpolymath@users.noreply.github.com> --- scripts/release.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/scripts/release.sh b/scripts/release.sh index 5f80ce0..77fed9f 100755 --- a/scripts/release.sh +++ b/scripts/release.sh @@ -44,7 +44,7 @@ cargo build --release # Create git tag echo -e "${YELLOW}Creating git tag v${VERSION}...${NC}" -git add Cargo.toml CHANGELOG.adoc +git add Cargo.toml Cargo.lock CHANGELOG.adoc git commit -m "chore: Release v${VERSION}" git tag -a "v${VERSION}" -m "Release v${VERSION}"