Skip to content

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

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 #70

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
b00163b
fix(scripts): repoint checks at the .adoc files that exist
hyperpolymath Aug 26, 2026
3c41392
fix(scripts): collapse duplicate-branch checks left by the .adoc repoint
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
36 changes: 18 additions & 18 deletions asdf-augmenters/asdf-ghjk/scripts/rsr-verify.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ echo ""
# =============================================================================
section "Category 1: Documentation"

check "README exists" "[[ -f README.md ]] || [[ -f README.adoc ]]"
check "README is comprehensive (>100 lines)" "[[ -f README.md ]] && [[ \$(wc -l < README.md) -gt 100 ]] || [[ -f README.adoc ]] && [[ \$(wc -l < README.adoc) -gt 100 ]]"
check "CONTRIBUTING exists" "[[ -f CONTRIBUTING.md ]] || [[ -f CONTRIBUTING.adoc ]]"
check "CODE_OF_CONDUCT.md exists" "[[ -f CODE_OF_CONDUCT.md ]]"
check "MAINTAINERS exists" "[[ -f MAINTAINERS.md ]] || [[ -f MAINTAINERS.adoc ]]"
check "SECURITY.md exists" "[[ -f SECURITY.md ]]"
check "CHANGELOG exists" "[[ -f CHANGELOG.md ]] || [[ -f CHANGELOG.adoc ]]"
check "README exists" "[[ -f README.adoc ]]"
check "README is comprehensive (>100 lines)" "[[ -f README.adoc ]] && [[ \$(wc -l < README.adoc) -gt 100 ]]"
check "CONTRIBUTING exists" "[[ -f CONTRIBUTING.adoc ]]"
check "CODE_OF_CONDUCT.adoc exists" "[[ -f CODE_OF_CONDUCT.adoc ]]"
check "MAINTAINERS exists" "[[ -f MAINTAINERS.adoc ]]"
check "SECURITY.adoc exists" "[[ -f SECURITY.adoc ]]"
check "CHANGELOG exists" "[[ -f CHANGELOG.adoc ]]"
check "ARCHITECTURE.md exists" "[[ -f docs/ARCHITECTURE.md ]]"
check "API_REFERENCE.md exists" "[[ -f docs/API_REFERENCE.md ]]"
check "FAQ.md exists" "[[ -f docs/FAQ.md ]]"
Expand All @@ -91,7 +91,7 @@ check "SPDX identifier present" "grep -q 'SPDX-License-Identifier' LICENSE.txt"
# =============================================================================
section "Category 3: Security"

check "SECURITY.md exists" "[[ -f SECURITY.md ]]"
check "SECURITY.adoc exists" "[[ -f SECURITY.adoc ]]"
check "security.txt exists" "[[ -f .well-known/security.txt ]]"
check "security.txt is RFC 9116 compliant" "grep -q 'Contact:' .well-known/security.txt"
check "Checksum verification in download script" "grep -q 'verify_checksum' bin/download"
Expand All @@ -103,8 +103,8 @@ check "Input validation present" "grep -q 'ASDF_INSTALL_VERSION' bin/download"
# =============================================================================
section "Category 4: Contributing"

check "CONTRIBUTING comprehensive (>50 lines)" "[[ -f CONTRIBUTING.md ]] && [[ \$(wc -l < CONTRIBUTING.md) -gt 50 ]] || [[ -f CONTRIBUTING.adoc ]] && [[ \$(wc -l < CONTRIBUTING.adoc) -gt 5 ]]"
check "CODE_OF_CONDUCT follows Contributor Covenant" "grep -q 'Contributor Covenant' CODE_OF_CONDUCT.md"
check "CONTRIBUTING comprehensive (>50 lines)" "[[ -f CONTRIBUTING.adoc ]] && [[ \$(wc -l < CONTRIBUTING.adoc) -gt 50 ]]"
check "CODE_OF_CONDUCT follows Contributor Covenant" "grep -q 'Contributor Covenant' CODE_OF_CONDUCT.adoc"
check "Issue templates exist" "[[ -d .github/ISSUE_TEMPLATE ]]"
check "Bug report template exists" "[[ -f .github/ISSUE_TEMPLATE/bug_report.md ]]"
check "Feature request template exists" "[[ -f .github/ISSUE_TEMPLATE/feature_request.md ]]"
Expand All @@ -115,10 +115,10 @@ check "PR template exists" "[[ -f .github/pull_request_template.md ]]"
# =============================================================================
section "Category 5: Governance"

check "MAINTAINERS exists" "[[ -f MAINTAINERS.md ]] || [[ -f MAINTAINERS.adoc ]]"
check "MAINTAINERS exists" "[[ -f MAINTAINERS.adoc ]]"
check "CODEOWNERS exists" "[[ -f .github/CODEOWNERS ]]"
check "Maintainer responsibilities documented" "grep -q 'Responsibilities' MAINTAINERS.md 2>/dev/null || grep -qi 'responsibilities' MAINTAINERS.adoc 2>/dev/null"
check "Decision-making process documented" "grep -q 'Decision Making' MAINTAINERS.md 2>/dev/null || grep -qi 'decision' MAINTAINERS.adoc 2>/dev/null || grep -q 'decision' MAINTAINERS.md 2>/dev/null"
check "Maintainer responsibilities documented" "grep -q 'Responsibilities' MAINTAINERS.adoc 2>/dev/null || grep -qi 'responsibilities' MAINTAINERS.adoc 2>/dev/null"
check "Decision-making process documented" "grep -qi 'decision' MAINTAINERS.adoc 2>/dev/null"
check "RSR.md with TPCF declaration exists" "[[ -f RSR.md ]]"
check "TPCF perimeter declared" "grep -q 'Perimeter 3' RSR.md"

Expand All @@ -140,7 +140,7 @@ check "CI tests multiple platforms" "grep -q 'ubuntu-latest' .github/workflows/c
section "Category 7: Build System"

check "Build system exists" "[[ -f Makefile ]] || [[ -f Justfile ]] || [[ -f Justfile ]]"
check "Justfile exists" "[[ -f Justfile ]] || [[ -f Justfile ]]"
check "Justfile exists" "[[ -f Justfile ]]"
check "Nix/Guix package definition exists" "[[ -f flake.nix ]] || [[ -f guix.scm ]] || [[ -f default.nix ]]"
check "Build system has test target" "grep -qi 'test' Makefile 2>/dev/null || grep -qi 'test' Justfile 2>/dev/null || grep -qi 'test' Justfile 2>/dev/null"
check "Build system has lint target" "grep -qi 'lint' Makefile 2>/dev/null || grep -qi 'lint' Justfile 2>/dev/null || grep -qi 'lint' Justfile 2>/dev/null"
Expand All @@ -152,9 +152,9 @@ check "Setup script is executable" "[[ -x scripts/setup-dev.sh ]]"
# =============================================================================
section "Category 8: Versioning"

check "CHANGELOG follows Keep a Changelog" "grep -qi 'Changelog' CHANGELOG.md 2>/dev/null || grep -qi 'Changelog' CHANGELOG.adoc 2>/dev/null"
check "CHANGELOG has Unreleased section" "grep -qi 'Unreleased' CHANGELOG.md 2>/dev/null || grep -qi 'Unreleased' CHANGELOG.adoc 2>/dev/null"
check "Semantic versioning mentioned" "grep -qi 'Semantic Versioning' CHANGELOG.md 2>/dev/null || grep -qi 'semver' CHANGELOG.adoc 2>/dev/null || grep -qi 'Semantic' CHANGELOG.adoc 2>/dev/null"
check "CHANGELOG follows Keep a Changelog" "grep -qi 'Changelog' CHANGELOG.adoc 2>/dev/null || grep -qi 'Changelog' CHANGELOG.adoc 2>/dev/null"
check "CHANGELOG has Unreleased section" "grep -qi 'Unreleased' CHANGELOG.adoc 2>/dev/null || grep -qi 'Unreleased' CHANGELOG.adoc 2>/dev/null"
check "Semantic versioning mentioned" "grep -qi 'Semantic Versioning' CHANGELOG.adoc 2>/dev/null || grep -qi 'semver' CHANGELOG.adoc 2>/dev/null || grep -qi 'Semantic' CHANGELOG.adoc 2>/dev/null"

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚪ LOW RISK

Suggestion: Combine the grep patterns into a more concise expression. grep -qi 'Semantic' will match the full phrase case-insensitively.


# =============================================================================
# Category 9: .well-known
Expand All @@ -176,7 +176,7 @@ section "Category 10: Community"
check "Issue templates directory exists" "[[ -d .github/ISSUE_TEMPLATE ]]"
check "Multiple issue templates" "[[ \$(ls -1 .github/ISSUE_TEMPLATE/*.md 2>/dev/null | wc -l) -ge 2 ]]"
check "PR template exists" "[[ -f .github/pull_request_template.md ]]"
check "CODE_OF_CONDUCT references enforcement" "grep -q 'Enforcement' CODE_OF_CONDUCT.md"
check "CODE_OF_CONDUCT references enforcement" "grep -q 'Enforcement' CODE_OF_CONDUCT.adoc"

# =============================================================================
# Category 11: Automation
Expand Down
2 changes: 1 addition & 1 deletion asdf-augmenters/asdf-ghjk/scripts/setup-dev.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,6 @@ echo "Next steps:"
echo " 1. Run tests: ./test/bats/bin/bats test/"
echo " 2. Lint code: shellcheck bin/* lib/*.sh lib/*.bash"
echo " 3. Try installing ghjk: asdf install ghjk latest"
echo " 4. Read CONTRIBUTING.md for development guidelines"
echo " 4. Read CONTRIBUTING.adoc for development guidelines"
echo ""
echo "Happy coding! 🎉"
36 changes: 18 additions & 18 deletions asdf-ghjk/scripts/rsr-verify.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,13 @@ echo ""
# =============================================================================
section "Category 1: Documentation"

check "README exists" "[[ -f README.md ]] || [[ -f README.adoc ]]"
check "README is comprehensive (>100 lines)" "[[ -f README.md ]] && [[ \$(wc -l < README.md) -gt 100 ]] || [[ -f README.adoc ]] && [[ \$(wc -l < README.adoc) -gt 100 ]]"
check "CONTRIBUTING exists" "[[ -f CONTRIBUTING.md ]] || [[ -f CONTRIBUTING.adoc ]]"
check "CODE_OF_CONDUCT.md exists" "[[ -f CODE_OF_CONDUCT.md ]]"
check "MAINTAINERS exists" "[[ -f MAINTAINERS.md ]] || [[ -f MAINTAINERS.adoc ]]"
check "SECURITY.md exists" "[[ -f SECURITY.md ]]"
check "CHANGELOG exists" "[[ -f CHANGELOG.md ]] || [[ -f CHANGELOG.adoc ]]"
check "README exists" "[[ -f README.adoc ]]"
check "README is comprehensive (>100 lines)" "[[ -f README.adoc ]] && [[ \$(wc -l < README.adoc) -gt 100 ]]"
check "CONTRIBUTING exists" "[[ -f CONTRIBUTING.adoc ]]"
check "CODE_OF_CONDUCT.adoc exists" "[[ -f CODE_OF_CONDUCT.adoc ]]"
check "MAINTAINERS exists" "[[ -f MAINTAINERS.adoc ]]"
check "SECURITY.adoc exists" "[[ -f SECURITY.adoc ]]"
check "CHANGELOG exists" "[[ -f CHANGELOG.adoc ]]"
check "ARCHITECTURE.md exists" "[[ -f docs/ARCHITECTURE.md ]]"
check "API_REFERENCE.md exists" "[[ -f docs/API_REFERENCE.md ]]"
check "FAQ.md exists" "[[ -f docs/FAQ.md ]]"
Expand All @@ -91,7 +91,7 @@ check "SPDX identifier present" "grep -q 'SPDX-License-Identifier' LICENSE.txt"
# =============================================================================
section "Category 3: Security"

check "SECURITY.md exists" "[[ -f SECURITY.md ]]"
check "SECURITY.adoc exists" "[[ -f SECURITY.adoc ]]"
check "security.txt exists" "[[ -f .well-known/security.txt ]]"
check "security.txt is RFC 9116 compliant" "grep -q 'Contact:' .well-known/security.txt"
check "Checksum verification in download script" "grep -q 'verify_checksum' bin/download"
Expand All @@ -103,8 +103,8 @@ check "Input validation present" "grep -q 'ASDF_INSTALL_VERSION' bin/download"
# =============================================================================
section "Category 4: Contributing"

check "CONTRIBUTING comprehensive (>50 lines)" "[[ -f CONTRIBUTING.md ]] && [[ \$(wc -l < CONTRIBUTING.md) -gt 50 ]] || [[ -f CONTRIBUTING.adoc ]] && [[ \$(wc -l < CONTRIBUTING.adoc) -gt 5 ]]"
check "CODE_OF_CONDUCT follows Contributor Covenant" "grep -q 'Contributor Covenant' CODE_OF_CONDUCT.md"
check "CONTRIBUTING comprehensive (>50 lines)" "[[ -f CONTRIBUTING.adoc ]] && [[ \$(wc -l < CONTRIBUTING.adoc) -gt 50 ]]"
check "CODE_OF_CONDUCT follows Contributor Covenant" "grep -q 'Contributor Covenant' CODE_OF_CONDUCT.adoc"
check "Issue templates exist" "[[ -d .github/ISSUE_TEMPLATE ]]"
check "Bug report template exists" "[[ -f .github/ISSUE_TEMPLATE/bug_report.md ]]"
check "Feature request template exists" "[[ -f .github/ISSUE_TEMPLATE/feature_request.md ]]"
Expand All @@ -115,10 +115,10 @@ check "PR template exists" "[[ -f .github/pull_request_template.md ]]"
# =============================================================================
section "Category 5: Governance"

check "MAINTAINERS exists" "[[ -f MAINTAINERS.md ]] || [[ -f MAINTAINERS.adoc ]]"
check "MAINTAINERS exists" "[[ -f MAINTAINERS.adoc ]]"
check "CODEOWNERS exists" "[[ -f .github/CODEOWNERS ]]"
check "Maintainer responsibilities documented" "grep -q 'Responsibilities' MAINTAINERS.md 2>/dev/null || grep -qi 'responsibilities' MAINTAINERS.adoc 2>/dev/null"
check "Decision-making process documented" "grep -q 'Decision Making' MAINTAINERS.md 2>/dev/null || grep -qi 'decision' MAINTAINERS.adoc 2>/dev/null || grep -q 'decision' MAINTAINERS.md 2>/dev/null"
check "Maintainer responsibilities documented" "grep -q 'Responsibilities' MAINTAINERS.adoc 2>/dev/null || grep -qi 'responsibilities' MAINTAINERS.adoc 2>/dev/null"
check "Decision-making process documented" "grep -qi 'decision' MAINTAINERS.adoc 2>/dev/null"
check "RSR.md with TPCF declaration exists" "[[ -f RSR.md ]]"
check "TPCF perimeter declared" "grep -q 'Perimeter 3' RSR.md"

Expand All @@ -140,7 +140,7 @@ check "CI tests multiple platforms" "grep -q 'ubuntu-latest' .github/workflows/c
section "Category 7: Build System"

check "Build system exists" "[[ -f Makefile ]] || [[ -f Justfile ]] || [[ -f Justfile ]]"
check "Justfile exists" "[[ -f Justfile ]] || [[ -f Justfile ]]"
check "Justfile exists" "[[ -f Justfile ]]"
check "Nix/Guix package definition exists" "[[ -f flake.nix ]] || [[ -f guix.scm ]] || [[ -f default.nix ]]"
check "Build system has test target" "grep -qi 'test' Makefile 2>/dev/null || grep -qi 'test' Justfile 2>/dev/null || grep -qi 'test' Justfile 2>/dev/null"
check "Build system has lint target" "grep -qi 'lint' Makefile 2>/dev/null || grep -qi 'lint' Justfile 2>/dev/null || grep -qi 'lint' Justfile 2>/dev/null"
Expand All @@ -152,9 +152,9 @@ check "Setup script is executable" "[[ -x scripts/setup-dev.sh ]]"
# =============================================================================
section "Category 8: Versioning"

check "CHANGELOG follows Keep a Changelog" "grep -qi 'Changelog' CHANGELOG.md 2>/dev/null || grep -qi 'Changelog' CHANGELOG.adoc 2>/dev/null"
check "CHANGELOG has Unreleased section" "grep -qi 'Unreleased' CHANGELOG.md 2>/dev/null || grep -qi 'Unreleased' CHANGELOG.adoc 2>/dev/null"
check "Semantic versioning mentioned" "grep -qi 'Semantic Versioning' CHANGELOG.md 2>/dev/null || grep -qi 'semver' CHANGELOG.adoc 2>/dev/null || grep -qi 'Semantic' CHANGELOG.adoc 2>/dev/null"
check "CHANGELOG follows Keep a Changelog" "grep -qi 'Changelog' CHANGELOG.adoc 2>/dev/null || grep -qi 'Changelog' CHANGELOG.adoc 2>/dev/null"
check "CHANGELOG has Unreleased section" "grep -qi 'Unreleased' CHANGELOG.adoc 2>/dev/null || grep -qi 'Unreleased' CHANGELOG.adoc 2>/dev/null"
check "Semantic versioning mentioned" "grep -qi 'Semantic Versioning' CHANGELOG.adoc 2>/dev/null || grep -qi 'semver' CHANGELOG.adoc 2>/dev/null || grep -qi 'Semantic' CHANGELOG.adoc 2>/dev/null"

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

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

⚪ LOW RISK

Suggestion: Combine the grep patterns into a more concise expression. grep -qi 'Semantic' is sufficient.


# =============================================================================
# Category 9: .well-known
Expand All @@ -176,7 +176,7 @@ section "Category 10: Community"
check "Issue templates directory exists" "[[ -d .github/ISSUE_TEMPLATE ]]"
check "Multiple issue templates" "[[ \$(ls -1 .github/ISSUE_TEMPLATE/*.md 2>/dev/null | wc -l) -ge 2 ]]"
check "PR template exists" "[[ -f .github/pull_request_template.md ]]"
check "CODE_OF_CONDUCT references enforcement" "grep -q 'Enforcement' CODE_OF_CONDUCT.md"
check "CODE_OF_CONDUCT references enforcement" "grep -q 'Enforcement' CODE_OF_CONDUCT.adoc"

# =============================================================================
# Category 11: Automation
Expand Down
2 changes: 1 addition & 1 deletion asdf-ghjk/scripts/setup-dev.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,6 @@ echo "Next steps:"
echo " 1. Run tests: ./test/bats/bin/bats test/"
echo " 2. Lint code: shellcheck bin/* lib/*.sh lib/*.bash"
echo " 3. Try installing ghjk: asdf install ghjk latest"
echo " 4. Read CONTRIBUTING.md for development guidelines"
echo " 4. Read CONTRIBUTING.adoc for development guidelines"
echo ""
echo "Happy coding! 🎉"
Loading