Skip to content

fix(scripts): repoint checks at the .adoc files that exist #84

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hyperpolymath merged 2 commits into from
Aug 26, 2026
Merged

fix(scripts): repoint checks at the .adoc files that exist #84

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3595fcc
fix(scripts): repoint checks at the .adoc files that exist
hyperpolymath Aug 26, 2026
eefc998
Update scripts/release.sh
hyperpolymath Aug 26, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions scripts/release.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 Cargo.lock CHANGELOG.adoc
git commit -m "chore: Release v${VERSION}"
git tag -a "v${VERSION}" -m "Release v${VERSION}"

Expand Down
26 changes: 13 additions & 13 deletions scripts/verify-rsr.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/"
Expand Down Expand Up @@ -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"

@codacy-production codacy-production Bot Aug 26, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚪ LOW RISK

Suggestion: Documentation checks should be case-insensitive for better reliability. Update line 108 of scripts/verify-rsr.sh to use 'grep -qi' for both pattern checks in the 'Contribution guidelines clear' validation.

echo ""

echo "🔍 RSR Category 9: Code Quality"
Expand All @@ -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 ""
Expand Down
Loading