Skip to content

feat: audit .github repo and add CLAUDE.md/AGENTS.md checks #14

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
don-petry merged 2 commits into from
Apr 5, 2026
Merged

feat: audit .github repo and add CLAUDE.md/AGENTS.md checks #14

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ddb07d5
feat: audit .github repo and add CLAUDE.md/AGENTS.md checks
Apr 5, 2026
58e86b9
fix: address review comments on CLAUDE.md/AGENTS.md checks
Apr 5, 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
66 changes: 58 additions & 8 deletions scripts/compliance-audit.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -401,6 +401,61 @@ check_workflow_permissions() {
done
}

# ---------------------------------------------------------------------------
# Check: CLAUDE.md exists and references AGENTS.md
# ---------------------------------------------------------------------------
check_claude_md() {
local repo="$1"

local content
content=$(gh_api "repos/$ORG/$repo/contents/CLAUDE.md" --jq '.content' 2>/dev/null || echo "")

if [ -z "$content" ]; then
add_finding "$repo" "standards" "missing-claude-md" "error" \
"Missing \`CLAUDE.md\` — every repo must have a CLAUDE.md that references AGENTS.md" \
"AGENTS.md"
return
fi

local decoded
decoded=$(echo "$content" | base64 -d 2>/dev/null || echo "")

if ! echo "$decoded" | grep -qi 'AGENTS\.md'; then
add_finding "$repo" "standards" "claude-md-missing-agents-ref" "error" \
"\`CLAUDE.md\` does not reference \`AGENTS.md\`" \
"AGENTS.md"
fi
}

# ---------------------------------------------------------------------------
# Check: AGENTS.md exists and references org .github/AGENTS.md
# ---------------------------------------------------------------------------
check_agents_md() {
local repo="$1"

local content
content=$(gh_api "repos/$ORG/$repo/contents/AGENTS.md" --jq '.content' 2>/dev/null || echo "")

if [ -z "$content" ]; then
add_finding "$repo" "standards" "missing-agents-md" "error" \
"Missing \`AGENTS.md\` — every repo must have an AGENTS.md that references the org-level standards" \
"AGENTS.md"
return
fi

# For repos other than .github, AGENTS.md should reference the org-level .github/AGENTS.md
if [ "$repo" != ".github" ]; then
local decoded
decoded=$(echo "$content" | base64 -d 2>/dev/null || echo "")

if ! echo "$decoded" | grep -qE '\.github/AGENTS\.md'; then
add_finding "$repo" "standards" "agents-md-missing-org-ref" "error" \
"\`AGENTS.md\` does not reference the org-level \`.github/AGENTS.md\` standards" \
"AGENTS.md"
fi
fi
}

# ---------------------------------------------------------------------------
# Issue management
# ---------------------------------------------------------------------------
Expand Down Expand Up @@ -585,7 +640,7 @@ HEREDOC

HEREDOC

for category in ci-workflows action-pinning dependabot settings labels rulesets; do
for category in ci-workflows action-pinning dependabot settings labels rulesets standards; do
local cat_count
cat_count=$(jq --arg cat "$category" '[.[] | select(.category == $cat)] | length' "$FINDINGS_FILE")
if [ "$cat_count" -gt 0 ]; then
Expand Down Expand Up @@ -624,11 +679,6 @@ main() {
local repo_count=0

for repo in $repos; do
# Skip the .github config repo itself (different compliance criteria)
if [ "$repo" = ".github" ]; then
continue
fi

repo_count=$((repo_count + 1))
log "Auditing $ORG/$repo"

Expand All @@ -648,6 +698,8 @@ main() {
check_codeowners "$repo"
check_sonarcloud "$repo"
check_workflow_permissions "$repo"
check_claude_md "$repo"
check_agents_md "$repo"

log_end
done
Expand All @@ -662,8 +714,6 @@ main() {
info "Managing issues..."

for repo in $repos; do
[ "$repo" = ".github" ] && continue

ensure_audit_label "$repo"

# Create issues for new findings (process substitution avoids subshell)
Expand Down
Loading