Check that all jobs are in all-tests-passed.needs (#432)

Author: eifinger

.github/scripts/check-all-tests-passed-needs.ts

@@ -0,0 +1,35 @@
+import * as fs from "node:fs";
+import * as yaml from "js-yaml";
+
+interface WorkflowJob {
+  needs?: string[];
+  [key: string]: unknown;
+}
+
+interface Workflow {
+  jobs: Record<string, WorkflowJob>;
+  [key: string]: unknown;
+}
+
+const workflow = yaml.load(
+  fs.readFileSync("../workflows/test.yml", "utf8"),
+) as Workflow;
+const jobs = Object.keys(workflow.jobs);
+const allTestsPassed = workflow.jobs["all-tests-passed"];
+const needs: string[] = allTestsPassed.needs || [];
+
+const expectedNeeds = jobs.filter((j) => j !== "all-tests-passed");
+const missing = expectedNeeds.filter((j) => !needs.includes(j));
+
+if (missing.length > 0) {
+  console.error(
+    `Missing jobs in all-tests-passed needs: ${missing.join(", ")}`,
+  );
+  console.info(
+    "Please add the missing jobs to the needs section of all-tests-passed in test.yml.",
+  );
+  process.exit(1);
+}
+console.log(
+  "All jobs in test.yml are in the needs section of all-tests-passed.",
+);

.github/workflows/test.yml

@@ -29,6 +29,11 @@ jobs:
           npm install
       - run: |
           npm run all
+      - name: Check all jobs are in all-tests-passed.needs
+        run: |
+          tsc check-all-tests-passed-needs.ts
+          node check-all-tests-passed-needs.js
+        working-directory: .github/scripts
       - name: Make sure no changes from linters are detected
         run: |
           git diff --exit-code || (echo "::error::Please run 'npm run all' to fix the issues" && exit 1)
@@ -548,9 +553,13 @@ jobs:
       - test-activate-environment
       - test-musl
       - test-cache-local
+      - test-setup-cache
       - test-restore-cache
+      - test-setup-cache-requirements-txt
       - test-restore-cache-requirements-txt
+      - test-setup-cache-dependency-glob
       - test-restore-cache-dependency-glob
+      - test-setup-cache-local
       - test-restore-cache-local
       - test-tilde-expansion-cache-local-path
       - test-tilde-expansion-cache-dependency-glob

package-lock.json

@@ -38,6 +38,7 @@
   },
   "devDependencies": {
     "@biomejs/biome": "1.9.4",
+    "@types/js-yaml": "^4.0.9",
     "@types/node": "^22.15.21",
     "@types/semver": "^7.7.0",
     "@vercel/ncc": "^0.38.3",