Proof Docs

GitHub pull requests

Proof reviews pull-request changes, selects approved tests, runs them, and reports in GitHub Check Runs.

When Proof runs

The GitHub App records the current pull-request head and ignores duplicate deliveries. Connecting a Project leaves pull-request execution paused. A bounded execution requires approval for the exact current head.

How tests are selected

Proof uses the Project context, generated tests, and source coverage to select work. The current bounded approval permits one test and records its exact version and spending limit.

If the context, test version, GitHub access, or pull-request head changes, the old approval cannot authorize a new run.

Read the Check Runs

GitHub Check Runs report the approved work and link to the Job. Review the result and its evidence before treating a pull request as tested.

Findings and source changes

Before it runs a test, Proof records the pull-request head as the source Change. When evidence supports a Finding, Proof posts the same summary and evidence in the pull request and dashboard.

A source Change shows what Proof checked. It does not prove that the pull request caused the Finding. An older Finding can remain valid without a source Change.

Administrator setup

Set GITHUB_APP_ID, GITHUB_PRIVATE_KEY, and GITHUB_WEBHOOK_SECRET. Set the webhook URL to https://your-proof-host/api/webhooks/github. Subscribe to pull-request events. Give the app access to pull requests, repository contents, and Check Runs.