@avi2dg/checks 0.41.0 → 0.41.1

package/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 Every release of `@avi2dg/checks`, newest first, written by the release from its conventional commits.
 
+## 0.41.1
+
+Released 2026-10-14.
+
+### Fixes
+
+- **delivery:** refuse workflow references to missing workflows or jobs in ci-wiring [#153](https://github.com/avi2d/checks/pull/153)
+
 ## 0.41.0
 
 Released 2026-10-12.

package/docs/gates/checks-ci-wiring.md

@@ -21,6 +21,14 @@ The check follows local reusable workflows but not remote reusable workflows.
 It refuses a step or job with `if: false` or `continue-on-error: true`.
 It also refuses a workflow that does not trigger on both `opened` and `synchronize` pull requests to the target branch.
 A path filter cannot cover every pull request and therefore cannot satisfy the check.
+It refuses a reference to a workflow or job the repository does not hold.
+Each literal `checks-release-pr` and `checks-release-tag` argument names a workflow file, so every one must match a file under `.github/workflows/`.
+An argument built from a variable or an expression is known only when the job runs, so the check passes over it.
+Each `on.workflow_run.workflows` entry names a workflow by its `name`, so every one must match a name in the repository.
+A workflow without a `name` answers to its path from the repository root.
+A local reusable `uses` must name a file under `.github/workflows/` that the repository holds.
+Each `needs` entry names a job in the same workflow, so every one must match a job id in that file.
+Each refusal names the file, the line and the missing workflow or job.
 
 ### Runners
 
@@ -57,7 +65,7 @@ It takes no arguments.
 | Code | Result |
 | --- | --- |
 | 0 | Every required command has a reachable step. |
-| 1 | A required command is missing or blocked, or a job runs on the wrong runner. |
+| 1 | A required command is missing or blocked, a job runs on the wrong runner, or a workflow names a missing workflow or job. |
 | 2 | A workflow or `package.json` cannot be decoded. |
 
 ## Sample output
@@ -77,6 +85,13 @@ ci-wiring: 1 job(s) run on the wrong runner:
   .github/workflows/mutation-compare.yml job mutation-compare: a mutation job reads CI_RUNS_ON, so an override moves its full sweeps off winbox; set runs-on: [self-hosted, Linux, X64, winbox]
 ```
 
+A reference to a missing workflow produces a report like this:
+
+```
+ci-wiring: 1 reference(s) name a missing workflow or job:
+  .github/workflows/daily-release.yml line 31: names missing workflow commitlint.yml
+```
+
 ## When it runs
 
 `checks-lint` runs it in every repository.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@avi2dg/checks",
-  "version": "0.41.0",
+  "version": "0.41.1",
   "description": "Deterministic checks shared across a set of TypeScript repositories",
   "license": "MIT",
   "repository": {
@@ -51,6 +51,7 @@
     "src/testing/subsumed-tests.ts",
     "src/delivery/ci-wiring.ts",
     "src/delivery/shell-command.ts",
+    "src/delivery/workflow-references.ts",
     "src/delivery/mutation-job.ts",
     "src/delivery/secrets.ts",
     "src/delivery/gitleaks.ts",

package/src/delivery/ci-wiring.ts

@@ -5,6 +5,7 @@ import { runMain } from "../core/main.ts";
 import { ENTRY_POINT, KIT_GATES, type KitGate } from "../core/gates.ts";
 import { readShellFiles, runsMutation, within, type Run } from "./mutation-job.ts";
 import { invokes, mentions, plainCommand, type Command } from "./shell-command.ts";
+import { findMissingWorkflows, formatMissingReport, isRecord, names, type Workflow } from "./workflow-references.ts";
 
 export type { Command };
 
@@ -20,11 +21,6 @@ export type Declaration = {
   readonly lintGates: readonly KitGate[];
 };
 
-export type Workflow = {
-  readonly path: string;
-  readonly document: unknown;
-};
-
 export type BlockedInvocation = {
   readonly location: string;
   readonly blocker: string;
@@ -84,16 +80,6 @@ const MUTATION_RUNNER = ["self-hosted", "Linux", "X64", "winbox"];
 const HOSTED_DEFAULT = "${{ vars.CI_RUNS_ON || 'ubuntu-latest' }}";
 const EventRepository = Schema.fromJsonString(Schema.Struct({ repository: Schema.Struct({ private: Schema.Boolean }) }));
 
-function isRecord(value: unknown): value is Record<string, unknown> {
-  return typeof value === "object" && value !== null && !Array.isArray(value);
-}
-
-function names(value: unknown): readonly string[] | undefined {
-  if (typeof value === "string") return [value];
-  if (!Array.isArray(value)) return undefined;
-  return value.filter((entry): entry is string => typeof entry === "string");
-}
-
 function constant(value: unknown): boolean | undefined {
   if (typeof value === "boolean") return value;
   if (typeof value !== "string") return undefined;
@@ -333,7 +319,7 @@ export function formatRunnerReport(faults: readonly RunnerFault[]): string {
 
 export const parseWorkflow = (path: string, text: string): Effect.Effect<Workflow, WiringError> =>
   Effect.try({
-    try: () => ({ path, document: Bun.YAML.parse(text) }),
+    try: () => ({ path, document: Bun.YAML.parse(text), text }),
     catch: (error) => new WiringError({ message: `cannot parse ${path}: ${String(error)}` }),
   });
 
@@ -386,11 +372,13 @@ const wiring = Effect.gen(function* () {
   const gaps = findGaps(declaration, workflows);
   const gapReport = formatReport(declaration, gaps);
   yield* gaps.length > 0 ? Console.error(gapReport) : Console.log(gapReport);
+  const missing = findMissingWorkflows(workflows);
+  if (missing.length > 0) yield* Console.error(formatMissingReport(missing));
   const scripts = yield* readScripts(root);
   const runs = workflows.flatMap((workflow) => workflowJobs(workflow).flatMap(([, job]) => jobRuns(workflow, job)));
   const faults = findRunnerFaults({ visibility: yield* readVisibility, scripts, files: yield* readShellFiles(root, scripts, runs) }, workflows);
   if (faults.length > 0) yield* Console.error(formatRunnerReport(faults));
-  return gaps.length === 0 && faults.length === 0;
+  return gaps.length === 0 && faults.length === 0 && missing.length === 0;
 });
 
 if (import.meta.main) runMain("ci-wiring", wiring);

package/src/delivery/workflow-references.ts

@@ -0,0 +1,198 @@
+import { fromProgram, shellCommands, type Command } from "./shell-command.ts";
+
+export type Workflow = {
+  readonly path: string;
+  readonly document: unknown;
+  readonly text: string;
+};
+
+export type MissingReference = {
+  readonly location: string;
+  readonly fault: string;
+};
+
+export function isRecord(value: unknown): value is Record<string, unknown> {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+
+export function names(value: unknown): readonly string[] | undefined {
+  if (typeof value === "string") return [value];
+  if (!Array.isArray(value)) return undefined;
+  return value.filter((entry): entry is string => typeof entry === "string");
+}
+
+type Key = string | number;
+
+type Locator = (keys: readonly Key[], needle: string, fallback: string) => string;
+
+// Lines from..to hold the node, and its child keys start at column.
+type Node = { readonly from: number; readonly to: number; readonly column: number };
+
+const WORKFLOWS = ".github/workflows";
+const RELEASE_BINS = ["checks-release-pr", "checks-release-tag"];
+const RELEASE_SOURCES = ["release-pr.ts", "release-tag.ts"];
+const REUSABLE_PREFIX = "./.github/workflows/";
+// GitHub substitutes an expression into the script before the shell reads it.
+const EXPRESSION = /\$\{\{[\s\S]*?\}\}/g;
+
+function isPathTo(word: string, files: readonly string[]): boolean {
+  return files.some((file) => word.endsWith(`/${file}`));
+}
+
+function releaseArguments(program: Command): readonly string[] {
+  const [head, target] = program;
+  if (head !== undefined && (RELEASE_BINS.includes(head) || isPathTo(head, RELEASE_BINS))) return program.slice(1);
+  if (head === "bun" && target !== undefined && (RELEASE_SOURCES.includes(target) || isPathTo(target, [...RELEASE_SOURCES, ...RELEASE_BINS]))) {
+    return program.slice(2);
+  }
+  return [];
+}
+
+function literalTargets(run: string): readonly string[] {
+  return shellCommands(run.replace(EXPRESSION, "$EXPRESSION"))
+    .flatMap((command) => releaseArguments(fromProgram(command)))
+    .filter((target) => !target.includes("$"));
+}
+
+function escapeRegExp(text: string): string {
+  return text.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
+}
+
+function indentOf(line: string): number {
+  return line.length - line.trimStart().length;
+}
+
+function meaningful(line: string): boolean {
+  const text = line.trim();
+  return text !== "" && !text.startsWith("#");
+}
+
+function belongs(line: string, column: number): boolean {
+  return !meaningful(line) || indentOf(line) > column || (indentOf(line) === column && line.trim().startsWith("-"));
+}
+
+function firstBodyLine(lines: readonly string[], from: number, to: number): string | undefined {
+  return lines.slice(from + 1, to).find(meaningful);
+}
+
+function child(lines: readonly string[], node: Node, key: string): Node | undefined {
+  const pattern = new RegExp(`^(\\s*(?:-\\s+)?)["']?${escapeRegExp(key)}["']?\\s*:(\\s|$)`);
+  for (let at = node.from; at < node.to; at += 1) {
+    if (pattern.exec(lines[at] ?? "")?.[1]?.length !== node.column) continue;
+    let to = at + 1;
+    while (to < node.to && belongs(lines[to] ?? "", node.column)) to += 1;
+    const body = firstBodyLine(lines, at, to);
+    return { from: at, to, column: body === undefined ? -1 : indentOf(body) };
+  }
+  return undefined;
+}
+
+function items(lines: readonly string[], node: Node): readonly Node[] {
+  const column = indentOf(firstBodyLine(lines, node.from, node.to) ?? "");
+  const starts: number[] = [];
+  for (let at = node.from + 1; at < node.to; at += 1) {
+    const line = lines[at] ?? "";
+    if (meaningful(line) && indentOf(line) === column && line.trim().startsWith("-")) starts.push(at);
+  }
+  return starts.map((from, index) => {
+    const to = starts[index + 1] ?? node.to;
+    const inline = /^\s*-\s+(?=\S)/.exec(lines[from] ?? "");
+    return { from, to, column: inline === null ? indentOf(firstBodyLine(lines, from, to) ?? "") : inline[0].length };
+  });
+}
+
+function nodeAt(lines: readonly string[], keys: readonly Key[]): Node | undefined {
+  return keys.reduce<Node | undefined>(
+    (node, key) => (node === undefined ? undefined : typeof key === "number" ? items(lines, node)[key] : child(lines, node, key)),
+    { from: 0, to: lines.length, column: 0 },
+  );
+}
+
+function locate(path: string, lines: readonly string[]): Locator {
+  const used = new Map<string, number>();
+  return (keys, needle, fallback) => {
+    const node = nodeAt(lines, keys);
+    if (node === undefined) return `${path} ${fallback}`;
+    const hits = lines.slice(node.from, node.to).flatMap((line, offset) => (line.includes(needle) ? [node.from + offset] : []));
+    const at = hits.find((line) => line > (used.get(needle) ?? -1)) ?? hits[0] ?? node.from;
+    used.set(needle, at);
+    return `${path} line ${at + 1}`;
+  };
+}
+
+function workflowTitle(document: unknown): string | undefined {
+  return isRecord(document) && typeof document["name"] === "string" ? document["name"] : undefined;
+}
+
+function missingNeeds(jobs: Readonly<Record<string, unknown>>, at: Locator): readonly MissingReference[] {
+  return Object.entries(jobs).flatMap(([id, job]) => {
+    if (!isRecord(job)) return [];
+    return (names(job["needs"]) ?? []).flatMap((need) =>
+      need in jobs ? [] : [{ location: at(["jobs", id, "needs"], need, `job ${id}`), fault: `job ${id} needs missing job ${need}` }],
+    );
+  });
+}
+
+function missingTarget(uses: string, paths: ReadonlySet<string>, at: Locator, keys: readonly Key[], fallback: string): MissingReference | undefined {
+  return uses.startsWith(REUSABLE_PREFIX) && !paths.has(uses.slice(2))
+    ? { location: at(keys, uses, fallback), fault: `names missing workflow ${uses.slice(2)}` }
+    : undefined;
+}
+
+function missingJobRefs(id: string, job: unknown, paths: ReadonlySet<string>, at: Locator): readonly MissingReference[] {
+  if (!isRecord(job)) return [];
+  const missing: MissingReference[] = [];
+  if (typeof job["uses"] === "string") {
+    const called = missingTarget(job["uses"], paths, at, ["jobs", id, "uses"], `job ${id}`);
+    if (called !== undefined) missing.push(called);
+  }
+  const steps = job["steps"];
+  if (!Array.isArray(steps)) return missing;
+  steps.forEach((step: unknown, index) => {
+    if (!isRecord(step)) return;
+    const fallback = `job ${id} step ${index + 1}`;
+    if (typeof step["uses"] === "string") {
+      const used = missingTarget(step["uses"], paths, at, ["jobs", id, "steps", index, "uses"], fallback);
+      if (used !== undefined) missing.push(used);
+    }
+    if (typeof step["run"] !== "string") return;
+    for (const target of literalTargets(step["run"])) {
+      if (!paths.has(`${WORKFLOWS}/${target}`)) {
+        missing.push({ location: at(["jobs", id, "steps", index, "run"], target, fallback), fault: `names missing workflow ${target}` });
+      }
+    }
+  });
+  return missing;
+}
+
+// GitHub names a workflow without a name by its path from the repository root.
+export function findMissingWorkflows(workflows: readonly Workflow[]): readonly MissingReference[] {
+  const paths = new Set(workflows.map((workflow) => workflow.path));
+  const titles = new Set(workflows.map((workflow) => workflowTitle(workflow.document) ?? workflow.path));
+  return workflows.flatMap((workflow) => {
+    const missing: MissingReference[] = [];
+    const at = locate(workflow.path, workflow.text.split("\n"));
+    const jobs = isRecord(workflow.document) ? workflow.document["jobs"] : undefined;
+    if (isRecord(jobs)) {
+      missing.push(...missingNeeds(jobs, at));
+      for (const [id, job] of Object.entries(jobs)) missing.push(...missingJobRefs(id, job, paths, at));
+    }
+    const on = isRecord(workflow.document) ? workflow.document["on"] : undefined;
+    const watched = isRecord(on) ? on["workflow_run"] : undefined;
+    if (isRecord(watched)) {
+      for (const entry of names(watched["workflows"]) ?? []) {
+        if (!titles.has(entry)) {
+          missing.push({ location: at(["on", "workflow_run", "workflows"], entry, "on workflow_run"), fault: `names missing workflow ${entry}` });
+        }
+      }
+    }
+    return missing;
+  });
+}
+
+export function formatMissingReport(faults: readonly MissingReference[]): string {
+  return [
+    `ci-wiring: ${faults.length} reference(s) name a missing workflow or job:`,
+    ...faults.map(({ location, fault }) => `  ${location}: ${fault}`),
+  ].join("\n");
+}