@rmartz/pr-policy 0.2.0 → 0.9.0

package/README.md

@@ -1,7 +1,7 @@
 # @rmartz/pr-policy
 
 **Is this pull request's content acceptable under policy?** `pr-policy` answers
-that on every PR, statically, from the PR's diff, title, and changed paths. It
+that on every PR, statically, from the PR's diff, title, description, and changed paths. It
 doesn't rely on a reviewer remembering to check.
 
 Each policy rule is a small read-only classifier. All of them report into **one**
@@ -12,12 +12,15 @@ new required-status name.
 
 ## Checks
 
-| Check                                                           | Blocks when                                                                                                                                                                                         |
-| --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| **CI-change classification** ([docs](docs/checks/ci-change.md)) | A `.github/workflows/**` change loosens CI (a removed job, `continue-on-error`, a narrowed trigger, …) and no human has applied `CI change approved` (shows as pending). Owns `CI approval needed`. |
-| **Title-type rules** ([docs](docs/checks/title.md))             | The squash title isn't a valid Conventional Commit, puts `!` on a non-functional type, or types a workflow change as anything but `ci` without the `breaking change` label.                         |
-| Domain labels (backlog)                                         | Never blocks. Additive path-glob → domain-label map.                                                                                                                                                |
-| Milestone inheritance (backlog)                                 | Never blocks. Issue → PR milestone.                                                                                                                                                                 |
+| Check                                                                 | Blocks when                                                                                                                                                                                                                        |
+| --------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| **Blocking labels** ([docs](docs/checks/merge-block.md))              | The PR carries `do not merge`, `dnm`, `blocked`, or `escalation needed` (shows as pending).                                                                                                                                        |
+| **CI-change classification** ([docs](docs/checks/ci-change.md))       | A `.github/workflows/**` change loosens CI (a removed job, `continue-on-error`, a narrowed trigger, …) and no human has applied `CI change approved` (shows as pending). Owns `CI approval needed`.                                |
+| **Title-type rules** ([docs](docs/checks/title.md))                   | The squash title isn't a valid Conventional Commit, puts `!` on a non-functional type, disagrees with the `breaking change` label, or types a linter/formatter bump as a non-release, non-`ci` type.                               |
+| **UAT sign-off** ([docs](docs/checks/uat.md))                         | The PR isn't docs, tests, CI, dependency-only, or repo metadata, and no trusted user has applied `UAT passed` (or `tested`) or `no UAT needed` (shows as pending).                                                                 |
+| **Dependabot claim verification** ([docs](docs/checks/dependabot.md)) | A Dependabot PR touches a non-dependency path, changes a dependency its description doesn't claim, pins a version other than the claimed one, or edits anything Dependabot never edits (a `package.json` script, a workflow step). |
+| Domain labels (backlog)                                               | Never blocks. Additive path-glob → domain-label map.                                                                                                                                                                               |
+| Milestone inheritance (backlog)                                       | Never blocks. Issue → PR milestone.                                                                                                                                                                                                |
 
 The design, and why this is separate from `merge-safety` and `pr-lifecycle`, is
 in [docs/decisions.md](docs/decisions.md).
@@ -33,9 +36,10 @@ is in its [consumer guide](https://github.com/rmartz/pr-policy-action/blob/main/
 Every check is importable. The `ai-pr-policy` CLI is a thin wrapper around them:
 
 ```bash
-ai-pr-policy evaluate --pr 12 --repo rmartz/pr-policy          # post the check-run + labels
+ai-pr-policy evaluate --pr 12 --repo rmartz/pr-policy          # post the check-run, status + labels
 ai-pr-policy evaluate --pr 12 --repo rmartz/pr-policy --json   # evaluate only, change nothing
 ai-pr-policy evaluate --facts pr.json                          # offline, from a JSON facts file
+ai-pr-policy evaluate --pr 12 --repo rmartz/pr-policy --skip-uat  # for a repo with no UAT
 ```
 
 ## Documentation

package/dist/bin/pr-policy.js

@@ -4,22 +4,25 @@ import {
   evaluatePolicy,
   gatherFacts,
   parseFacts,
-  postCheckRun,
-  resolveRepoTarget
-} from "../chunk-QINHHFJN.js";
+  postVerdict,
+  resolveRepoTarget,
+  selectChecks
+} from "../chunk-PVXDVMME.js";
 
 // src/bin/pr-policy.ts
 import { readFile } from "fs/promises";
 import { parseArgs } from "util";
 var USAGE = `Usage:
-  ai-pr-policy evaluate --pr <n> [--repo <owner/repo>] [--json]
-  ai-pr-policy evaluate --facts <path|->
+  ai-pr-policy evaluate --pr <n> [--repo <owner/repo>] [--json] [--skip-uat]
+  ai-pr-policy evaluate --facts <path|-> [--skip-uat]
 
---pr     Evaluate a live PR, post the pr-policy check-run on its head, and
-         apply the label edits the checks planned. --json prints the
-         evaluation instead and changes nothing.
+--pr     Evaluate a live PR, post the pr-policy check-run and commit status on
+         its head, and apply the label edits the checks planned. --json
+         prints the evaluation instead and changes nothing.
 --facts  Evaluate an offline JSON facts document ("-" reads stdin) and print
-         the evaluation. Exits 1 only on "failure" ("pending" exits 0).`;
+         the evaluation. Exits 1 only on "failure" ("pending" exits 0).
+--skip-uat
+         Don't run the UAT gate, for a repo with no user-acceptance testing.`;
 async function readInput(path) {
   if (path !== "-") return readFile(path, "utf8");
   const chunks = [];
@@ -35,6 +38,7 @@ async function main(argv) {
       pr: { type: "string" },
       repo: { type: "string" },
       json: { type: "boolean" },
+      "skip-uat": { type: "boolean" },
       help: { type: "boolean", short: "h" }
     }
   });
@@ -46,8 +50,9 @@ async function main(argv) {
     console.error(USAGE);
     return 2;
   }
+  const checks = selectChecks({ skipUat: values["skip-uat"] });
   if (values.facts !== void 0) {
-    const evaluation2 = await evaluatePolicy(parseFacts(await readInput(values.facts)));
+    const evaluation2 = await evaluatePolicy(parseFacts(await readInput(values.facts)), checks);
     console.log(JSON.stringify(evaluation2, null, 2));
     return evaluation2.outcome === "failure" ? 1 : 0;
   }
@@ -63,13 +68,13 @@ async function main(argv) {
   }
   const target = { repo, pr };
   const { facts, headSha } = await gatherFacts(target);
-  const evaluation = await evaluatePolicy(facts);
+  const evaluation = await evaluatePolicy(facts, checks);
   if (values.json) {
     console.log(JSON.stringify(evaluation, null, 2));
     return 0;
   }
   await applyLabelEdits(target, evaluation);
-  await postCheckRun(target, headSha, evaluation);
+  await postVerdict(target, headSha, evaluation);
   console.log(`${repo}#${pr}: ${evaluation.outcome} \u2014 ${evaluation.title}`);
   return 0;
 }