Skip to content

first-use.md

Latest commit

 

History

History
39 lines (29 loc) · 1.57 KB

first-use.md

File metadata and controls

39 lines (29 loc) · 1.57 KB
Raw

First use: get one PatchGate result

The first useful result is a non-blocking check on a real pull request. It should tell a maintainer what evidence is present and what still needs a human decision without changing merge eligibility.

Shadow setup

For a local policy-only first result from this repository, run:

npm ci
npm run first-use

This checks the trusted local main Git ref. It does not claim authenticated GitHub access or replace the Action shadow setup below.

  1. Open the Action usage guide and create the workflow on the repository's default branch.
  2. Use v0.1.0-beta.5, keep fail-on: never, and set create-check-run: true.
  3. Open or update one pull request and read the PatchGate check summary.

The workflow reads trusted metadata. It must not check out or execute pull-request code in the privileged lane. A standard GITHUB_TOKEN cannot read Administration, so a complete branch-protection or Rulesets snapshot may remain fail-closed. That is an expected boundary, not a successful evaluation.

What to record

Record the repository type, beta tag or commit, time to the first check, the first confusing result, and whether the summary changed what you reviewed. Use the first-use feedback form for a redacted report. Do not include tokens, private repository data, or unredacted pull-request contents.

This walkthrough proves a setup path. It does not prove that PatchGate is popular, production-ready, or useful for every repository shape.