@async/pipeline 0.9.12 → 0.9.13

package/dist/internal/node/github.js

@@ -20,8 +20,8 @@ function defineActionRef(id, uses, sha, label) {
         ref: `${uses}@${sha} # ${label}`
     };
 }
-const ASYNC_ACTIONS_SHA = "c08a62380ee60fa175d5c3598d41c4485c0ead98";
-const ASYNC_ACTIONS_LABEL = "v0.1.12";
+const ASYNC_ACTIONS_SHA = "87e033782ca1f84334d9e3a2543b0db064848fb7";
+const ASYNC_ACTIONS_LABEL = "v0.1.14";
 const ASYNC_RELEASE_COMMAND = "npx --yes github:async/release#3892d94a4890600d26b812052aa58dec98b05bfb";
 const GENERATED_ACTIONS = [
     defineActionRef("async.actions.setup", "async/actions/setup", ASYNC_ACTIONS_SHA, ASYNC_ACTIONS_LABEL),
@@ -37,6 +37,7 @@ const GENERATED_ACTIONS = [
     defineActionRef("async.actions.source-impact", "async/actions/source-impact", ASYNC_ACTIONS_SHA, ASYNC_ACTIONS_LABEL),
     defineActionRef("async.actions.cache", "async/actions/cache", ASYNC_ACTIONS_SHA, ASYNC_ACTIONS_LABEL),
     defineActionRef("async.actions.attest", "async/actions/attest", ASYNC_ACTIONS_SHA, ASYNC_ACTIONS_LABEL),
+    defineActionRef("async.actions.contract", "async/actions/contract", ASYNC_ACTIONS_SHA, ASYNC_ACTIONS_LABEL),
     defineActionRef("actions.checkout", "actions/checkout", "de0fac2e4500dabe0009e67214ff5f5447ce83dd", "v6.0.2"),
     defineActionRef("pnpm.setup", "pnpm/setup", "cf03a9b516e09bc5a90f041fc26fc930c9dc631b", "v1.0.0"),
     defineActionRef("deno.setup", "denoland/setup-deno", "667a34cdef165d8d2b2e98dde39547c9daac7282", "v2.0.4"),
@@ -59,6 +60,7 @@ const ASYNC_AGENT_EVIDENCE_ACTION = actionRef("async.actions.agent-evidence");
 const ASYNC_SOURCE_IMPACT_ACTION = actionRef("async.actions.source-impact");
 const ASYNC_CACHE_ACTION = actionRef("async.actions.cache");
 const ASYNC_ATTEST_ACTION = actionRef("async.actions.attest");
+const ASYNC_CONTRACT_ACTION = actionRef("async.actions.contract");
 const CHECKOUT_ACTION = actionRef("actions.checkout");
 const PNPM_SETUP_ACTION = actionRef("pnpm.setup");
 const DENO_SETUP_ACTION = actionRef("deno.setup");
@@ -103,6 +105,7 @@ export async function renderGitHubWorkflow(pipeline, options) {
         evidence: renderModel.evidence,
         sourceImpact: renderModel.sourceImpact,
         attest: renderModel.attest,
+        contract: renderModel.contract,
         bridge: renderModel.bridge,
         pages: renderModel.pages,
         manualDispatchJobs: renderModel.manualDispatchJobs,
@@ -133,6 +136,7 @@ export async function renderGitHubWorkflow(pipeline, options) {
         evidence: renderModel.evidence,
         sourceImpact: renderModel.sourceImpact,
         attest: renderModel.attest,
+        contract: renderModel.contract,
         bridge: renderModel.bridge,
         pages: renderModel.pages,
         manualDispatchJobs: renderModel.manualDispatchJobs
@@ -458,6 +462,14 @@ function buildGeneratedJobManifests(model, rendered, event, network, selectedPip
             skipReason: selected ? "" : "event_filter"
         });
     }
+    if (model.contract.enabled) {
+        const selected = contractSelected(model.contract, event);
+        candidates.push({
+            manifest: buildContractManifest(model, rendered, event, network),
+            selected,
+            skipReason: selected ? "" : skipReasonForGeneratedJob(event, [model.contract.job])
+        });
+    }
     if (model.dependabotAutoMerge.enabled) {
         const selected = event.name === "pull_request_target";
         candidates.push({
@@ -705,13 +717,14 @@ function agentEvidenceManifestSteps(model, job) {
     }
     return steps;
 }
-function evidenceCollectManifestSteps(model) {
+function evidenceCollectManifestSteps(model, options = {}) {
     if (!model.evidence.enabled)
         return [];
+    const paths = [...new Set([...model.evidence.paths, ...(options.extraPaths ?? [])])];
     return [
         actionManifestStep("collect-evidence-manifest", "Collect evidence manifest", ASYNC_EVIDENCE_ACTION, {
             mode: "collect",
-            paths: model.evidence.paths,
+            paths,
             "receipt-paths": model.evidence.receiptPaths,
             "manifest-path": ".async/evidence/${{ github.job }}/manifest.json",
             "summary-path": ".async/evidence/${{ github.job }}/summary.md",
@@ -722,6 +735,32 @@ function evidenceCollectManifestSteps(model) {
         }, "evidence", { if: "${{ always() }}" })
     ];
 }
+function contractActionInput(contract) {
+    return sortObject({
+        mode: contract.mode,
+        checks: contractChecks(contract).join(","),
+        "package-path": contract.packagePath,
+        ...(contract.schema.enabled
+            ? {
+                "schema-sources": contract.schema.sources.join("\n"),
+                "schema-output": contract.schema.output
+            }
+            : {}),
+        "evidence-dir": contract.evidenceDir,
+        annotations: contract.annotations,
+        "fail-on": contract.mode === "report" ? "advisory" : "blocking"
+    });
+}
+function contractChecks(contract) {
+    const checks = [];
+    if (contract.api)
+        checks.push("api");
+    if (contract.claims)
+        checks.push("claims");
+    if (contract.schema.enabled)
+        checks.push("schema");
+    return checks;
+}
 function runActionManifestStep(id, name, command, env, contract, extraWith = {}) {
     const networked = commandLooksNetworked(command);
     return actionManifestStep(id, name, ASYNC_RUN_ACTION, {
@@ -876,6 +915,8 @@ function artifactPathForContract(contract) {
         return ".async/evidence";
     if (contract === "agent-evidence")
         return ".async/actions/agent-evidence";
+    if (contract === "contract")
+        return ".async/contract";
     if (contract === "pages")
         return ".async/pages";
     return ".async/runs";
@@ -983,6 +1024,30 @@ function buildBridgeManifest(model, rendered, event, network) {
         network
     });
 }
+function buildContractManifest(model, rendered, event, network) {
+    const contract = model.contract;
+    const steps = [
+        checkoutStep(),
+        ...setupManifestSteps(model),
+        ...dependencyInstallManifestSteps(model),
+        ...(model.buildCommand ? [shellManifestStep("build-pipeline-cli", "Build pipeline CLI", model.buildCommand, "build")] : []),
+        actionManifestStep("run-contract-evidence", "Run contract evidence", ASYNC_CONTRACT_ACTION, contractActionInput(contract), "contract"),
+        ...evidenceCollectManifestSteps(model, { extraPaths: [contract.evidenceDir] })
+    ];
+    return makeJobManifest(model, rendered, event, {
+        id: contract.job,
+        kind: "generated",
+        target: [],
+        runsOn: "ubuntu-latest",
+        permissions: { contents: "read" },
+        environment: null,
+        concurrency: null,
+        if: renderContractCondition(contract),
+        trigger: contract.mode === "release" ? ["release", "workflow_dispatch"] : ["pull_request", "workflow_dispatch"],
+        steps,
+        network
+    });
+}
 function buildEvidenceFanInManifest(model, rendered, event, network) {
     return makeJobManifest(model, rendered, event, {
         id: model.evidence.job,
@@ -1088,6 +1153,14 @@ function bridgeSelected(bridge, event) {
         return Boolean(bridge.schedule && (!event.schedule || event.schedule === bridge.schedule));
     return event.name === "workflow_dispatch" && event.selectedJob === bridge.job;
 }
+function contractSelected(contract, event) {
+    if (event.name === "workflow_dispatch")
+        return event.selectedJob === contract.job;
+    if (contract.mode === "release") {
+        return event.name === "release" && (!event.action || event.action === "published");
+    }
+    return event.name === "pull_request";
+}
 function skipReasonForJob(event, trigger) {
     if (event.name === "workflow_dispatch" && !event.selectedJob && trigger.some((id) => id === "manual"))
         return "manual_selector_missing";
@@ -1142,6 +1215,7 @@ function buildRenderModel(pipeline, options) {
     const evidence = resolveGitHubEvidence(pipeline);
     const pages = resolveGitHubPages(pipeline);
     const bridge = resolveGitHubBridge(pipeline);
+    const contract = resolveGitHubContract(pipeline, { pages, bridge });
     if (pages.enabled) {
         if (pages.triggers.pullRequest) {
             addGitHubEventTrigger(triggers, "pull_request");
@@ -1153,6 +1227,14 @@ function buildRenderModel(pipeline, options) {
     if (bridge.actionsJob.scheduled && bridge.schedule) {
         addScheduleTrigger(triggers, bridge.schedule, "async-bridge");
     }
+    if (contract.enabled) {
+        if (contract.mode === "release") {
+            addReleasePublishedTrigger(triggers);
+        }
+        else {
+            addPullRequestTrigger(triggers, "pull_request");
+        }
+    }
     const manualDispatchJobs = Object.values(pipeline.jobs)
         .filter((job) => job.trigger.some((triggerId) => pipeline.triggers[triggerId]?.type === "manual"))
         .map((job) => job.id)
@@ -1165,6 +1247,10 @@ function buildRenderModel(pipeline, options) {
         manualDispatchJobs.push(bridge.job);
         manualDispatchJobs.sort((left, right) => left.localeCompare(right));
     }
+    if (contract.enabled) {
+        manualDispatchJobs.push(contract.job);
+        manualDispatchJobs.sort((left, right) => left.localeCompare(right));
+    }
     const nodeVersion = pipeline.sync.github.nodeVersion ?? DEFAULT_NODE_VERSION;
     const runtime = resolveRuntimeSpecs(pipeline.sync.github.runtime, options.projectKind, nodeVersion);
     const setup = resolveGitHubSetup(pipeline.sync.github.setup, options.packageManager, options.packageManagerVersion);
@@ -1216,6 +1302,7 @@ function buildRenderModel(pipeline, options) {
         evidence,
         sourceImpact,
         attest: pipeline.sync.github.attest,
+        contract,
         bridge,
         pages,
         manualDispatchJobs
@@ -1234,6 +1321,30 @@ function resolveGitHubEvidence(pipeline) {
     }
     return config;
 }
+function resolveGitHubContract(pipeline, generated) {
+    const config = pipeline.sync.github.contract;
+    if (!config.enabled)
+        return config;
+    const jobId = config.job.toLowerCase();
+    if (Object.keys(pipeline.jobs).some((id) => id.toLowerCase() === jobId)) {
+        throw pipelineError("ASYNC_PIPELINE_GITHUB_CONTRACT_JOB_CONFLICT", `sync.github.contract.job "${config.job}" conflicts with an existing pipeline job. Remove the explicit job or set sync.github.contract.job to a different id.`);
+    }
+    const generatedJobs = new Set();
+    if (pipeline.sync.github.packagePreviews.enabled)
+        generatedJobs.add("package-preview");
+    if (pipeline.sync.github.dependabotAutoMerge.enabled)
+        generatedJobs.add("dependabot-auto-merge");
+    if (pipeline.sync.github.evidence.enabled)
+        generatedJobs.add(pipeline.sync.github.evidence.job);
+    if (generated.pages.enabled)
+        generatedJobs.add(generated.pages.job);
+    if (generated.bridge.actionsJob.enabled)
+        generatedJobs.add(generated.bridge.job);
+    if ([...generatedJobs].some((id) => id.toLowerCase() === jobId)) {
+        throw pipelineError("ASYNC_PIPELINE_GITHUB_CONTRACT_JOB_CONFLICT", `sync.github.contract.job "${config.job}" conflicts with a generated GitHub job. Set sync.github.contract.job to a different id.`);
+    }
+    return config;
+}
 function resolveGitHubSourceImpactJobs(pipeline, cwd, jobs) {
     const config = pipeline.sync.github.sourceImpact;
     if (!config.enabled)
@@ -1246,8 +1357,9 @@ function resolveGitHubSourceImpactJobs(pipeline, cwd, jobs) {
         "dependabot-auto-merge",
         "async-bridge",
         pipeline.sync.github.evidence.job,
+        pipeline.sync.github.contract.enabled ? pipeline.sync.github.contract.job : "",
         pipeline.sync.github.pages.job
-    ].map((id) => id.toLowerCase()));
+    ].filter(Boolean).map((id) => id.toLowerCase()));
     const existingJobIds = new Set(Object.keys(pipeline.jobs).map((id) => id.toLowerCase()));
     const result = [];
     for (const jobId of selectedJobIds) {
@@ -1344,6 +1456,16 @@ function addPullRequestTrigger(triggers, event) {
         types: [...new Set([...existingTypes, "opened", "reopened", "synchronize", "ready_for_review"])].sort()
     });
 }
+function addReleasePublishedTrigger(triggers) {
+    const existing = triggers.release && typeof triggers.release === "object" && !Array.isArray(triggers.release)
+        ? triggers.release
+        : {};
+    const existingTypes = Array.isArray(existing.types) ? existing.types.filter((value) => typeof value === "string") : [];
+    triggers.release = sortObject({
+        ...existing,
+        types: [...new Set([...existingTypes, "published"])].sort()
+    });
+}
 function addGitHubEventTrigger(triggers, event) {
     if (triggers[event] === undefined) {
         triggers[event] = {};
@@ -1468,6 +1590,9 @@ function renderWorkflow(model) {
     if (model.bridge.actionsJob.enabled) {
         renderBridgeJob(lines, model);
     }
+    if (model.contract.enabled) {
+        renderContractJob(lines, model);
+    }
     if (model.evidence.enabled) {
         renderEvidenceFanInJob(lines, model);
     }
@@ -1651,7 +1776,8 @@ function renderEvidenceCollectStep(lines, model, options = {}) {
     if (!model.evidence.enabled)
         return;
     const suffix = options.matrix ? "${{ github.job }}-${{ strategy.job-index }}" : "${{ github.job }}";
-    lines.push("", "      - name: Collect evidence manifest", "        if: ${{ always() }}", `        uses: ${ASYNC_EVIDENCE_ACTION}`, "        with:", "          mode: collect", "          paths: |", ...model.evidence.paths.map((path) => `            ${path}`), ...(model.evidence.receiptPaths.length > 0
+    const paths = [...new Set([...model.evidence.paths, ...(options.extraPaths ?? [])])];
+    lines.push("", "      - name: Collect evidence manifest", "        if: ${{ always() }}", `        uses: ${ASYNC_EVIDENCE_ACTION}`, "        with:", "          mode: collect", "          paths: |", ...paths.map((path) => `            ${path}`), ...(model.evidence.receiptPaths.length > 0
         ? [
             "          receipt-paths: |",
             ...model.evidence.receiptPaths.map((path) => `            ${path}`)
@@ -2058,6 +2184,32 @@ function renderBridgePullStep(lines, bridge) {
     ].map(shellWord).join(" ");
     lines.push("", "      - name: Pull and apply Async bridge change sets", `        uses: ${ASYNC_RUN_ACTION}`, "        with:", `          command: ${JSON.stringify(command)}`, "          check-generated: false", "          artifact-name: async-bridge-${{ github.run_id }}", "        env:", "          CI: true", `          ASYNC_PROJECT_URL: \${{ vars.${bridge.endpointVar} }}`, `          ASYNC_PROJECT_TOKEN: \${{ secrets.${bridge.tokenEnv} }}`, "          GITHUB_REPOSITORY: ${{ github.repository }}", "          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}");
 }
+function renderContractJob(lines, model) {
+    const contract = model.contract;
+    lines.push(`  ${yamlKey(contract.job)}:`, `    name: ${contract.job}`, `    if: ${renderContractCondition(contract)}`, "    runs-on: ubuntu-latest", "    permissions:", "      contents: read", "    steps:", "      - name: Checkout", `        uses: ${CHECKOUT_ACTION}`, "", ...renderSetupSteps(model), ...renderDependencyInstallSteps(model));
+    if (model.buildCommand) {
+        lines.push("", "      - name: Build pipeline CLI", `        run: ${model.buildCommand}`);
+    }
+    renderContractActionStep(lines, contract);
+    renderEvidenceCollectStep(lines, model, { extraPaths: [contract.evidenceDir] });
+    lines.push("");
+}
+function renderContractActionStep(lines, contract) {
+    lines.push("", "      - name: Run contract evidence", `        uses: ${ASYNC_CONTRACT_ACTION}`, "        with:", `          mode: ${contract.mode}`, `          checks: ${JSON.stringify(contractChecks(contract).join(","))}`, `          package-path: ${JSON.stringify(contract.packagePath)}`, ...(contract.schema.enabled
+        ? [
+            "          schema-sources: |",
+            ...contract.schema.sources.map((source) => `            ${source}`),
+            `          schema-output: ${JSON.stringify(contract.schema.output)}`
+        ]
+        : []), `          evidence-dir: ${JSON.stringify(contract.evidenceDir)}`, `          annotations: ${contract.annotations ? "true" : "false"}`, `          fail-on: ${contract.mode === "report" ? "advisory" : "blocking"}`);
+}
+function renderContractCondition(contract) {
+    const manual = `github.event_name == 'workflow_dispatch' && github.event.inputs.job == '${escapeExpressionString(contract.job)}'`;
+    if (contract.mode === "release") {
+        return `(github.event_name == 'release' && github.event.action == 'published') || (${manual})`;
+    }
+    return `(github.event_name == 'pull_request' && github.event.pull_request.draft == false) || (${manual})`;
+}
 function renderEvidenceFanInJob(lines, model) {
     const needs = evidenceProducerJobIds(model);
     if (needs.length === 0)
@@ -2077,6 +2229,8 @@ function evidenceProducerJobIds(model) {
         ids.add("package-preview");
     if (model.bridge.actionsJob.enabled)
         ids.add(model.bridge.job);
+    if (model.contract.enabled)
+        ids.add(model.contract.job);
     ids.delete(model.evidence.job);
     return [...ids].sort((left, right) => left.localeCompare(right));
 }