Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 .github/workflows/proof-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ permissions:

jobs:
proof:
uses: saagpatel/proof-pr/.github/workflows/proof-pr-receipt.yml@v0.2.7
uses: saagpatel/proof-pr/.github/workflows/proof-pr-receipt.yml@v0.2.8
with:
receipt_path: proof-pr.json
proof_pr_ref: v0.2.7
proof_pr_ref: v0.2.8
check_public_git_metadata: true
public_git_metadata_mode: introduced
artifact_name: github-repo-auditor-proof-pr
Expand Down
11 changes: 6 additions & 5 deletions docs/proof-pr-dogfood.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ environment and render the proof block from a generated receipt:
```bash
python3 -m venv /tmp/gra-proof-pr-venv
/tmp/gra-proof-pr-venv/bin/python -m pip install \
git+https://github.com/saagpatel/proof-pr.git@v0.2.7
git+https://github.com/saagpatel/proof-pr.git@v0.2.8
/tmp/gra-proof-pr-venv/bin/proof-pr init \
--cwd . \
--tier T1 \
Expand All @@ -25,13 +25,14 @@ python3 -m venv /tmp/gra-proof-pr-venv
/tmp/gra-proof-pr.json
/tmp/gra-proof-pr-venv/bin/proof-pr receipt-hygiene \
/tmp/gra-proof-pr.json \
--explain
--explain \
--check public-git-metadata \
--fix-only
Comment on lines +29 to +30

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Use a T3 receipt for the focused metadata check

This example still initializes the temporary receipt with --tier T1, but the new --check public-git-metadata --fix-only command only works when that hygiene finding exists. I checked proof-pr v0.2.8's CLI semantics: cmd_receipt_hygiene filters to the requested check and exits 2 when no finding matches, while _receipt_hygiene_findings only emits public-git-metadata for tier T3 or higher. As written, readers who copy the documented local check will get receipt hygiene: no finding for check public-git-metadata instead of the promised copyable remediation, so the example should either use a T3 tier or avoid focusing on that check.

Useful? React with 👍 / 👎.

```

`receipt-hygiene --explain` is the author-facing nudge for incomplete receipts.
It keeps hygiene read-only, but adds copyable commands and compact receipt patch
examples for missing evidence such as public git metadata, secrets posture,
permission posture, or rollback specificity.
Add `--check <id> --fix-only` when you want just one copyable command and compact
receipt patch, instead of the full hygiene report. It keeps hygiene read-only.

For GithubRepoAuditor, keep the risk tier honest:

Expand Down
Loading