willfire 0.1.0 → 0.1.2

package/dist/predict.js

@@ -77,33 +77,40 @@ function getPrTrigger(wf) {
     }
     return MISSING;
 }
+// A predicate: does this workflow produce a run for the PR? Every workflow-level
+// verdict is decidable, so there is no third answer to express. Only job
+// expansion can be genuinely undecidable (dynamic matrix, non-local reusable
+// workflow, unresolvable `if`), and that is a per-entry status.
 function workflowDispatches(wf, ctx) {
     const trig = getPrTrigger(wf);
     if (trig === MISSING)
-        return ["no-dispatch", "no pull_request trigger"];
+        return [false, "no pull_request trigger"];
     const types = trig["types"] ?? DEFAULT_TYPES;
     if (!types.includes(ctx.action)) {
-        return ["no-dispatch", `action '${ctx.action}' not in types [${types}]`];
+        return [false, `action '${ctx.action}' not in types [${types}]`];
     }
+    // Setting a filter and its -ignore twin on one trigger is invalid config.
+    // GitHub does not fall back to "no filter" or skip the workflow: it creates
+    // the run and concludes `startup_failure`. The run exists, so it dispatches.
     if ("branches" in trig && "branches-ignore" in trig) {
-        return ["unknown", "both branches and branches-ignore set"];
+        return [true, "both branches and branches-ignore set: startup failure"];
     }
     if ("branches" in trig && !matchFilters(ctx.baseRef, trig["branches"])) {
-        return ["no-dispatch", `base branch '${ctx.baseRef}' not in branches`];
+        return [false, `base branch '${ctx.baseRef}' not in branches`];
     }
     if ("branches-ignore" in trig && matchFilters(ctx.baseRef, trig["branches-ignore"])) {
-        return ["no-dispatch", "base branch in branches-ignore"];
+        return [false, "base branch in branches-ignore"];
     }
     if ("paths" in trig && "paths-ignore" in trig) {
-        return ["unknown", "both paths and paths-ignore set"];
+        return [true, "both paths and paths-ignore set: startup failure"];
     }
     if ("paths" in trig && !ctx.files.some((f) => matchFilters(f, trig["paths"]))) {
-        return ["no-dispatch", "no changed file matches paths"];
+        return [false, "no changed file matches paths"];
     }
     if ("paths-ignore" in trig && ctx.files.every((f) => matchFilters(f, trig["paths-ignore"]))) {
-        return ["no-dispatch", "all changed files match paths-ignore"];
+        return [false, "all changed files match paths-ignore"];
     }
-    return ["dispatch", "trigger matched"];
+    return [true, "trigger matched"];
 }
 /** Return list of matrix combination dicts, or null if dynamic. */
 export function expandMatrix(strategy) {
@@ -308,11 +315,14 @@ export async function predict(octokit, repo, prNumber) {
         }
         const content = await fetchFile(path);
         if (content == null) {
+            // The Actions API keeps listing a workflow as `active` after its file is
+            // deleted. There is no file at head, so there is nothing to dispatch —
+            // the same verdict as the disabled case above, reached a different way.
             entries.push({
                 workflow: path,
                 job: "*",
-                status: "unknown",
-                reason: "cannot fetch workflow file at head",
+                status: "no-dispatch",
+                reason: "no workflow file at head",
             });
             continue;
         }
@@ -321,17 +331,20 @@ export async function predict(octokit, repo, prNumber) {
             wf = parseYaml(content);
         }
         catch (e) {
+            // GitHub creates a run for an unparseable workflow file and concludes it
+            // `startup_failure`. The run exists but has no jobs, so this is a
+            // workflow-level "it dispatches" with nothing to expand.
             entries.push({
                 workflow: path,
                 job: "*",
-                status: "unknown",
+                status: "run",
                 reason: `YAML parse error: ${e}`,
             });
             continue;
         }
-        const [verdict, reason] = workflowDispatches(wf, ctx);
-        if (verdict !== "dispatch") {
-            entries.push({ workflow: path, job: "*", status: verdict, reason });
+        const [dispatches, reason] = workflowDispatches(wf, ctx);
+        if (!dispatches) {
+            entries.push({ workflow: path, job: "*", status: "no-dispatch", reason });
             continue;
         }
         for (const [jobName, status, jreason] of await expandJobs(wf, ctx, fetchFile)) {

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "willfire",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Predict the set of CI check entries GitHub Actions will create for a pull request",
   "license": "MIT",
   "author": "Kevin Scott <me@thekevinscott.com>",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/thekevinscott/willrun.git"
+    "url": "git+https://github.com/thekevinscott/willfire.git"
   },
   "keywords": [
     "github-actions",