新增项目发布 gate result matrix API
This commit is contained in:
@@ -36,13 +36,15 @@ continuation records are in `../text14.txt`.
|
||||
overview exposes the API surface inventory as a read-only summary row.
|
||||
- CI dashboards and external SDK callers can use
|
||||
`createProjectReleaseGateManifest()` to discover required gate commands and
|
||||
expected smoke outputs, and `createProjectReleaseReadinessReport()` for a
|
||||
machine-readable release readiness report covering the same manifest, the
|
||||
sim-config inventory baseline, and blocked runtime families. The report
|
||||
helper is evidence driven and only reports `ready: true` when the caller
|
||||
supplies release gate evidence such as `project_release_gate=ok`. The project
|
||||
release gate writes the same report to `build/project-release-readiness.json`
|
||||
and validates it with `verify_project_release_readiness_artifact.sh`.
|
||||
expected smoke outputs, `createProjectReleaseGateResultMatrix()` to map
|
||||
observed outputs onto passed/unknown gate rows, and
|
||||
`createProjectReleaseReadinessReport()` for a machine-readable release
|
||||
readiness report covering the same manifest, result matrix, sim-config
|
||||
inventory baseline, and blocked runtime families. The report helper is
|
||||
evidence driven and only reports `ready: true` when the caller supplies
|
||||
release gate evidence such as `project_release_gate=ok`. The project release
|
||||
gate writes the same report to `build/project-release-readiness.json` and
|
||||
validates it with `verify_project_release_readiness_artifact.sh`.
|
||||
External tools can load that artifact with
|
||||
`parseProjectReleaseReadinessArtifactJson()` and validate it with
|
||||
`createProjectReleaseReadinessArtifactValidation()`.
|
||||
|
||||
@@ -52,6 +52,7 @@ import {
|
||||
createMachineSessionPersistenceSummary,
|
||||
createMachineSessionSnapshotPayload,
|
||||
createProjectReleaseGateManifest,
|
||||
createProjectReleaseGateResultMatrix,
|
||||
createProjectReleaseReadinessArtifactValidation,
|
||||
createProjectReleaseReadinessReport,
|
||||
createSessionSnapshot,
|
||||
@@ -192,12 +193,13 @@ It does not implement or reinterpret LinuxCNC error semantics.
|
||||
|
||||
`createProjectReleaseGateManifest()` returns the required release gate IDs,
|
||||
commands, expected smoke outputs, and gate count for CI dashboards and external
|
||||
SDK callers. `createProjectReleaseReadinessReport()` returns a
|
||||
machine-readable release readiness report that embeds the same manifest beside
|
||||
the current gate results, sim-config inventory baseline, and blocked runtime
|
||||
families. It is evidence driven: the default report is `ready: false` until the
|
||||
caller supplies observed gate output such as `project_release_gate=ok` or
|
||||
explicit gate results.
|
||||
SDK callers. `createProjectReleaseGateResultMatrix()` maps observed gate output
|
||||
and explicit gate results onto that manifest as stable `passed`/`unknown` rows.
|
||||
`createProjectReleaseReadinessReport()` returns a machine-readable release
|
||||
readiness report that embeds the same manifest and result matrix beside the
|
||||
sim-config inventory baseline and blocked runtime families. It is evidence
|
||||
driven: the default report is `ready: false` until the caller supplies observed
|
||||
gate output such as `project_release_gate=ok` or explicit gate results.
|
||||
|
||||
This helper does not execute shell commands and does not inspect or implement
|
||||
CNC behavior. It only packages project-level release evidence and blocked
|
||||
|
||||
@@ -2,6 +2,7 @@ export { createLinuxCncIniSdk } from "./linuxcnc-ini.js";
|
||||
export { createLinuxCncInterpSdk } from "./linuxcnc-interp.js";
|
||||
export {
|
||||
createProjectReleaseGateManifest,
|
||||
createProjectReleaseGateResultMatrix,
|
||||
createProjectReleaseReadinessArtifactValidation,
|
||||
createProjectReleaseReadinessReport,
|
||||
parseProjectReleaseReadinessArtifactJson,
|
||||
|
||||
@@ -113,16 +113,14 @@ export function createProjectReleaseGateManifest() {
|
||||
};
|
||||
}
|
||||
|
||||
export function createProjectReleaseReadinessReport({
|
||||
export function createProjectReleaseGateResultMatrix({
|
||||
gateResults = {},
|
||||
observedOutputs = [],
|
||||
simConfigInventory = DEFAULT_SIM_CONFIG_INVENTORY_BASELINE,
|
||||
blockedRuntimeFamilies = BLOCKED_RUNTIME_FAMILIES,
|
||||
promotedRuntimeFamilies = [],
|
||||
manifest = createProjectReleaseGateManifest(),
|
||||
} = {}) {
|
||||
const outputs = Array.isArray(observedOutputs) ? observedOutputs : [];
|
||||
const gateManifest = createProjectReleaseGateManifest();
|
||||
const gateRows = gateManifest.gates.map((gate) => {
|
||||
const gates = Array.isArray(manifest?.gates) ? manifest.gates : [];
|
||||
const rows = gates.map((gate) => {
|
||||
const passed = readGatePassed({ gate, gateResults, observedOutputs: outputs });
|
||||
return {
|
||||
id: gate.id,
|
||||
@@ -133,6 +131,34 @@ export function createProjectReleaseReadinessReport({
|
||||
passed,
|
||||
};
|
||||
});
|
||||
return {
|
||||
apiName: "project-release-gate-result-matrix",
|
||||
matrixVersion: 1,
|
||||
phase: rows.every(({ passed }) => passed) ? "ready" : "waiting",
|
||||
ready: rows.every(({ passed }) => passed),
|
||||
gateCount: rows.length,
|
||||
passedCount: rows.filter(({ passed }) => passed).length,
|
||||
unknownCount: rows.filter(({ passed }) => !passed).length,
|
||||
missingGateIds: rows.filter(({ passed }) => !passed).map(({ id }) => id),
|
||||
manifest,
|
||||
rows,
|
||||
};
|
||||
}
|
||||
|
||||
export function createProjectReleaseReadinessReport({
|
||||
gateResults = {},
|
||||
observedOutputs = [],
|
||||
simConfigInventory = DEFAULT_SIM_CONFIG_INVENTORY_BASELINE,
|
||||
blockedRuntimeFamilies = BLOCKED_RUNTIME_FAMILIES,
|
||||
promotedRuntimeFamilies = [],
|
||||
} = {}) {
|
||||
const gateManifest = createProjectReleaseGateManifest();
|
||||
const gateResultMatrix = createProjectReleaseGateResultMatrix({
|
||||
gateResults,
|
||||
observedOutputs,
|
||||
manifest: gateManifest,
|
||||
});
|
||||
const gateRows = gateResultMatrix.rows;
|
||||
const releaseGatePassed = gateRows.find(({ id }) => id === "project-release-gate")?.passed === true;
|
||||
const inventory = {
|
||||
...DEFAULT_SIM_CONFIG_INVENTORY_BASELINE,
|
||||
@@ -166,6 +192,7 @@ export function createProjectReleaseReadinessReport({
|
||||
promotedRuntimeFamilies: promotedFamilies,
|
||||
promotedBlockedFamilies,
|
||||
gateManifest,
|
||||
gateResultMatrix,
|
||||
gates: gateRows,
|
||||
rows: [
|
||||
{
|
||||
|
||||
@@ -32,6 +32,7 @@ for (const phrase of [
|
||||
"PROJECT_COMPLETION_TRACKER.md",
|
||||
"runtime/sdk/src/index.js",
|
||||
"createProjectReleaseGateManifest()",
|
||||
"createProjectReleaseGateResultMatrix()",
|
||||
"createProjectReleaseReadinessReport()",
|
||||
"parseProjectReleaseReadinessArtifactJson()",
|
||||
"createProjectReleaseReadinessArtifactValidation()",
|
||||
@@ -98,6 +99,7 @@ for (const phrase of [
|
||||
"OPFS/session persistence exports",
|
||||
"Project release readiness export",
|
||||
"createProjectReleaseGateManifest()",
|
||||
"createProjectReleaseGateResultMatrix()",
|
||||
"createProjectReleaseReadinessReport()",
|
||||
"parseProjectReleaseReadinessArtifactJson()",
|
||||
"createProjectReleaseReadinessArtifactValidation()",
|
||||
|
||||
@@ -2,6 +2,7 @@ import assert from "node:assert/strict";
|
||||
|
||||
import {
|
||||
createProjectReleaseGateManifest,
|
||||
createProjectReleaseGateResultMatrix,
|
||||
createProjectReleaseReadinessReport,
|
||||
} from "../../../runtime/sdk/src/index.js";
|
||||
|
||||
@@ -42,10 +43,46 @@ assert.equal(
|
||||
"SKIP_INI_BUILD=1 SKIP_INTERP_BUILD=1 wasm-port/tests/browser/verify_release_artifact_url_workflow_browser.sh",
|
||||
);
|
||||
|
||||
const partialMatrix = createProjectReleaseGateResultMatrix({
|
||||
gateResults: {
|
||||
"diff-check": true,
|
||||
},
|
||||
observedOutputs: [
|
||||
"vendor sync up to date",
|
||||
"browser_release_artifact_url_workflow_smoke=ok",
|
||||
],
|
||||
});
|
||||
assert.equal(partialMatrix.apiName, "project-release-gate-result-matrix");
|
||||
assert.equal(partialMatrix.matrixVersion, 1);
|
||||
assert.equal(partialMatrix.phase, "waiting");
|
||||
assert.equal(partialMatrix.ready, false);
|
||||
assert.equal(partialMatrix.gateCount, 10);
|
||||
assert.equal(partialMatrix.passedCount, 3);
|
||||
assert.equal(partialMatrix.unknownCount, 7);
|
||||
assert.deepEqual(partialMatrix.missingGateIds, [
|
||||
"standalone-cnc-semantics",
|
||||
"interp-wasm",
|
||||
"sim-config-inventory",
|
||||
"ini-panel-browser",
|
||||
"ui-node-smokes",
|
||||
"host-smokes",
|
||||
"project-release-gate",
|
||||
]);
|
||||
assert.deepEqual(
|
||||
partialMatrix.rows.filter(({ passed }) => passed).map(({ id }) => id),
|
||||
[
|
||||
"diff-check",
|
||||
"vendor-sync",
|
||||
"release-artifact-url-browser",
|
||||
],
|
||||
);
|
||||
|
||||
const report = createProjectReleaseReadinessReport({
|
||||
gateResults: Object.fromEntries(manifest.gateIds.map((id) => [id, true])),
|
||||
});
|
||||
assert.deepEqual(report.gateManifest, manifest);
|
||||
assert.equal(report.gateResultMatrix.ready, true);
|
||||
assert.equal(report.gateResultMatrix.passedCount, manifest.gateCount);
|
||||
assert.deepEqual(report.gates.map(({ id }) => id), manifest.gateIds);
|
||||
assert.equal(report.gates.length, manifest.gateCount);
|
||||
|
||||
|
||||
@@ -33,6 +33,7 @@ import {
|
||||
createMachineSessionPersistenceRenderState,
|
||||
createMachineSessionPersistenceSummary,
|
||||
createProjectReleaseGateManifest,
|
||||
createProjectReleaseGateResultMatrix,
|
||||
createProjectReleaseReadinessArtifactValidation,
|
||||
createProjectReleaseReadinessReport,
|
||||
parseProjectReleaseReadinessArtifactJson,
|
||||
@@ -85,6 +86,7 @@ const requiredExports = [
|
||||
["createLinuxCncIniSdk", createLinuxCncIniSdk],
|
||||
["createLinuxCncInterpSdk", createLinuxCncInterpSdk],
|
||||
["createProjectReleaseGateManifest", createProjectReleaseGateManifest],
|
||||
["createProjectReleaseGateResultMatrix", createProjectReleaseGateResultMatrix],
|
||||
["createProjectReleaseReadinessArtifactValidation", createProjectReleaseReadinessArtifactValidation],
|
||||
["createProjectReleaseReadinessReport", createProjectReleaseReadinessReport],
|
||||
["parseProjectReleaseReadinessArtifactJson", parseProjectReleaseReadinessArtifactJson],
|
||||
@@ -217,6 +219,13 @@ const releaseReadinessReady = createProjectReleaseReadinessReport({
|
||||
assert.equal(releaseReadinessReady.ready, true);
|
||||
assert.equal(releaseReadinessReady.releaseGate.passed, true);
|
||||
assert.deepEqual(releaseReadinessReady.gateManifest, createProjectReleaseGateManifest());
|
||||
assert.equal(releaseReadinessReady.gateResultMatrix.rows.length, 10);
|
||||
assert.equal(
|
||||
createProjectReleaseGateResultMatrix({
|
||||
observedOutputs: ["project_release_gate=ok"],
|
||||
}).rows.find(({ id }) => id === "project-release-gate")?.passed,
|
||||
true,
|
||||
);
|
||||
const releaseReadinessArtifact = parseProjectReleaseReadinessArtifactJson(JSON.stringify(createProjectReleaseReadinessReport({
|
||||
gateResults: {
|
||||
"diff-check": true,
|
||||
|
||||
Reference in New Issue
Block a user