|
| 1 | +# proof-pr Dogfood |
| 2 | + |
| 3 | +GithubRepoAuditor uses `proof-pr` as an advisory proof receipt lane for PRs that |
| 4 | +change workflow, proof, public evidence, release, or review surfaces. The |
| 5 | +committed `proof-pr.json` is the dogfood receipt for the original workflow |
| 6 | +adoption; keep it historical unless a PR is intentionally refreshing that |
| 7 | +receipt. |
| 8 | + |
| 9 | +For local author checks, install the current public tag in a temporary |
| 10 | +environment and render the proof block from a generated receipt: |
| 11 | + |
| 12 | +```bash |
| 13 | +python3 -m venv /tmp/gra-proof-pr-venv |
| 14 | +/tmp/gra-proof-pr-venv/bin/python -m pip install git+https://github.com/saagpatel/proof-pr.git@v0.2.7 |
| 15 | +/tmp/gra-proof-pr-venv/bin/proof-pr init --cwd . --tier T1 --summary "Short PR summary" --output /tmp/gra-proof-pr.json |
| 16 | +/tmp/gra-proof-pr-venv/bin/proof-pr collect /tmp/gra-proof-pr.json --cwd . |
| 17 | +/tmp/gra-proof-pr-venv/bin/proof-pr render /tmp/gra-proof-pr.json |
| 18 | +/tmp/gra-proof-pr-venv/bin/proof-pr receipt-hygiene /tmp/gra-proof-pr.json --explain |
| 19 | +``` |
| 20 | + |
| 21 | +`receipt-hygiene --explain` is the author-facing nudge for incomplete receipts. |
| 22 | +It keeps hygiene read-only, but adds copyable commands and compact receipt patch |
| 23 | +examples for missing evidence such as public git metadata, secrets posture, |
| 24 | +permission posture, or rollback specificity. |
| 25 | + |
| 26 | +For GithubRepoAuditor, keep the risk tier honest: |
| 27 | + |
| 28 | +- `T0`: documentation-only changes with no runtime effect. |
| 29 | +- `T1`: narrow code changes covered by focused tests or a targeted verifier. |
| 30 | +- `T2`: user-visible CLI, output, workbook, schema, or API behavior changes. |
| 31 | +- `T3`: GitHub Actions, workflow permissions, public evidence, writeback, |
| 32 | + generated truth surfaces, or agent/operator access changes. |
| 33 | +- `T4`: releases, migrations, security-sensitive changes, or irreversible |
| 34 | + external writes. |
| 35 | + |
| 36 | +The receipt is review evidence, not supply-chain provenance. Release/build tiers |
| 37 | +should link separate attestations or artifact digests when those are relevant. |
0 commit comments