Support for lifecycle stages to stations. Organized api audit checklist and reporting to lifecycle stages and stations. Improved audit and design labels.

Author: mniinio

package.json

@@ -35,7 +35,7 @@
     "release:create-apiops:publish": "npm publish --workspace packages/create-apiops --access public",
     "check:packaging:skills": "node scripts/check-packaging-skills.mjs",
     "check:package:contents": "node scripts/check-package-contents.mjs",
-    "test:create-apiops": "node scripts/test-create-apiops-scaffold.mjs && node scripts/test-method-cli.mjs"
+    "test:create-apiops": "node scripts/test-create-apiops-scaffold.mjs && node scripts/test-method-cli.mjs && node scripts/test-run-design-audit.mjs"
   },
   "devDependencies": {
     "@changesets/cli": "^2.29.7",

packages/create-apiops/template/scripts/run-design-audit.js

@@ -10,6 +10,7 @@ const linesJson = readJson("src/data/method/lines.json");
 const resourcesJson = readJson("src/data/method/resources.json");
 const criteriaJson = readJson("src/data/method/criteria.json");
 const stakeholdersJson = readJson("src/data/method/stakeholders.json");
+const stationCriteriaJson = readJson("src/data/method/station-criteria.json");
 const canvasDataJson = readJson("src/data/canvas/canvasData.json");
 const localizedCanvasDataJson = readJson("src/data/canvas/localizedData.json");
 const knownResourceIds = new Set((resourcesJson.resources || []).map((resource) => resource.id));
@@ -23,6 +24,7 @@ const localeDirs = readdirSync("src/data/method", { withFileTypes: true })
   .filter((entry) => entry.isDirectory())
   .map((entry) => entry.name);
 const findings = [];
+const lifecycleStages = new Set(["strategy", "architecture", "design", "delivery", "publishing", "improving"]);
 
 function collectMatchingStringValues(node, pattern, results = new Set()) {
   if (typeof node === "string") {
@@ -104,6 +106,22 @@ for (const station of stationGroups) {
       );
     }
   }
+
+  if (station.group === "core-stations") {
+    if (!lifecycleStages.has(station.lifecycleStage)) {
+      findings.push(`Core station ${station.id} is missing a valid lifecycleStage.`);
+    }
+
+    const expectedCriteria = stationCriteriaJson[station.id] || [];
+    const actualCriteria = station.stationCriteria || [];
+    if (JSON.stringify(actualCriteria) !== JSON.stringify(expectedCriteria)) {
+      findings.push(`Core station ${station.id} stationCriteria does not match station-criteria.json.`);
+    }
+
+    if (!Array.isArray(station.expectedEvidenceTags) || station.expectedEvidenceTags.length === 0) {
+      findings.push(`Core station ${station.id} must define expectedEvidenceTags.`);
+    }
+  }
 }
 
 for (const line of linesJson.lines?.items || []) {

scripts/test-method-content-integrity.mjs

@@ -42,6 +42,8 @@ try {
   const auditSnippet = renderSnippet("api-audit-checklist", "en", { forceUnicode: true });
   assert(auditSnippet.includes("\"profiles\""), "Expected api-audit-checklist to render the JSON checklist snippet.");
   assert(auditSnippet.includes("\"read-only\""), "Expected api-audit-checklist JSON snippet to include the read-only profile.");
+  assert(auditSnippet.includes("\"stages\""), "Expected api-audit-checklist JSON snippet to include lifecycle stages.");
+  assert(auditSnippet.includes("\"producedByStation\""), "Expected api-audit-checklist JSON snippet to include station ownership links.");
 
   const styleSnippet = renderSnippet("api-design-principles", "en", { forceAscii: true });
   assert(styleSnippet.includes("\"guidelines\""), "Expected api-design-principles to render the JSON style snippet.");