Add external audit package index#159
Conversation
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
Claude Code Review
This repository is configured for manual code reviews. Comment @claude review to trigger a review and subscribe this PR to future pushes, or @claude review once for a one-time review.
Tip: disable this comment in your organization's Code Review settings.
|
@coderabbitai review Please review the Gate F audit-package index and checker wiring. Scope is documentation/tooling only: no Solidity behavior, ABI, or bytecode changes are intended. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdds an auditor-facing index ( ChangesAudit Package Feature
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
🧩 Analysis chain🏁 Script executed: #!/bin/bash
# Get the list of changed files in the PR
gh pr view 159 --repo 6529-Collections/6529Stream --json files --jq '.files[].path'Length of output: 677 🏁 Script executed: #!/bin/bash
# Read the main new files
echo "=== docs/audit-package.md ==="
cat docs/audit-package.md
echo ""
echo "=== scripts/check_audit_package.py ==="
cat scripts/check_audit_package.py
echo ""
echo "=== scripts/test_audit_package.py ==="
cat scripts/test_audit_package.pyLength of output: 22080 🏁 Script executed: #!/bin/bash
echo "=== Makefile (audit-package-related targets) ==="
grep -n "audit" Makefile || echo "No audit targets found"
echo ""
echo "=== scripts/check.sh (audit-package section) ==="
grep -n "audit" scripts/check.sh || echo "No audit references"
echo ""
echo "=== CI config changes ==="
fd -e yml -e yaml . .github/workflows/ | xargs grep -l "audit" 2>/dev/null | head -5
for f in $(fd -e yml -e yaml . .github/workflows/ | xargs grep -l "audit" 2>/dev/null | head -5); do
echo "--- $f ---"
cat "$f"
done
echo ""
echo "=== release-artifacts/latest/release-manifest.json ==="
cat release-artifacts/latest/release-manifest.json 2>/dev/null || echo "Not found"
echo ""
echo "=== release-artifacts/latest/SHA256SUMS ==="
cat release-artifacts/latest/SHA256SUMS 2>/dev/null || echo "Not found"
echo ""
echo "=== release-artifacts/latest/release-checksums.json ==="
cat release-artifacts/latest/release-checksums.json 2>/dev/null || echo "Not found"Length of output: 43919 🏁 Script executed: #!/bin/bash
echo "=== scripts/check.ps1 (audit section) ==="
grep -n "audit" scripts/check.ps1 || echo "No audit references"
echo ""
echo "=== scripts/generate_release_manifest.py (docs list) ==="
grep -n "audit" scripts/generate_release_manifest.py || echo "No audit references"
echo ""
echo "=== CHANGELOG or changelog references ==="
fd -e md changelog docs -d 2 | head -5
grep -rn "audit-package" docs/ --include="*.md" -l 2>/dev/null
echo ""
echo "=== README audit references ==="
grep -n "audit" README.md | head -20
echo ""
echo "=== Verify all linked files in audit-package.md exist ==="
# Extract markdown links from audit-package.md and check if files exist
python3 - <<'EOF'
import re, os
with open("docs/audit-package.md") as f:
content = f.read()
# Find all markdown links
links = re.findall(r'\[.*?\]\((.*?)\)', content)
print("=== Links found in audit-package.md ===")
for link in links:
# Skip anchors and external URLs
if link.startswith('#') or link.startswith('http'):
continue
# Resolve relative to docs/
resolved = os.path.normpath(os.path.join("docs", link))
exists = os.path.exists(resolved)
print(f" {'OK' if exists else 'MISSING'}: {link} -> {resolved}")
EOFLength of output: 5497
|
| Area | Finding | Severity |
|---|---|---|
check_audit_package.py linked_repo_paths |
Fails on first missing file; inconsistent with accumulate pattern | Minor |
test_audit_package.py test_rejects_missing_required_link |
Unguarded string replacement could produce false-positive | Nit |
docs/audit-package.md ## Package Maintenance |
generate vs. check distinction not explained | Nit |
AuditPackageError base class |
RuntimeError vs. ValueError |
Nit |
Everything else looks correct: the document content is accurate, every link resolves to an existing file, all wiring paths are consistent (Makefile / shell / PowerShell / CI), the CI step ordering is correct, and the release-manifest governance-doc entry and checksums are present and consistent.
✅ Action performed
Review finished.
Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.
1 participant
Summary
Closes #158.
Adds a Gate F external audit package index for the current pre-audit local baseline, plus deterministic validation so the package does not silently lose required scope, maturity, evidence, or security-reporting links.
What changed
docs/audit-package.mdas the auditor-facing index over maturity/scope, reviewer entry points, ADRs, invariants/test evidence, Slither/static-analysis disposition, deployment/release evidence, known blockers vs accepted local-baseline dispositions, security reporting, and local verification commands.scripts/check_audit_package.pyandscripts/test_audit_package.pyto enforce required headings, required pre-audit/non-production language, required commands, required evidence links, and missing linked-file failures.Makefile,scripts/check.sh,scripts/check.ps1, and CI.docs/audit-package.mdto release-manifest governance docs and regeneratedrelease-artifacts/latest/release-manifest.json,SHA256SUMS, andrelease-checksums.json.Non-goals
Local validation
python scripts\test_audit_package.pypython scripts\check_audit_package.pypython -m py_compile scripts\check_audit_package.py scripts\test_audit_package.py scripts\generate_release_manifest.py scripts\test_release_manifest.pypython scripts\test_release_manifest.pypython scripts\generate_release_manifest.py --checkpython scripts\test_release_checksums.pypython scripts\generate_release_checksums.py --checkpython scripts\test_changelog_check.pypython scripts\check_changelog.pybash -n scripts/check.shbash -n scripts/bootstrap-ec2.shscripts\check.ps1andscripts\bootstrap-windows.ps1rg -n "^#|^##|^###" docs\audit-package.md ops\ROADMAP.md README.md docs\tooling.md docs\status.md release-artifacts\README.mdgit diff --checkmake checkpowershell -ExecutionPolicy Bypass -File scripts\check.ps1Existing warning noise observed locally: Solidity
selfdestructwarnings in forced-ETH test helpers, existing Foundry source-parser warnings for test helper/script files, and the existing Windows line-ending warning forscripts/check.ps1duringgit diff --check.Summary by CodeRabbit
New Features
Documentation
Tests
Chores