@intentius/chant 0.124.31 → 0.124.33

package/dist/workspace/ci-run.js

@@ -1,5 +1,5 @@
 /**
- * `chant ci run plan|apply` (#4094, epic #4101): run one pull-request job as
+ * `chant ci run plan|record|apply` (#4094, epic #4101, record #4168): run one pull-request job as
  * a pipeline Op, the first slice of the chant runner.
  *
  * The job is the typed value `prLoopJobs` (../components/pr-pipeline.ts)
@@ -44,6 +44,30 @@
  * With a forge client (#4097) the job also sets a commit status at its
  * commit: `pending` when it starts, `success` or `failure` when it settles.
  * A status the forge refuses is a warning and never fails the job.
+ *
+ * Signing is opt-in (#4156). With no runner key the record is unsigned, and
+ * a reader counts it with no signer. A key `.chant/trust.json` does not list
+ * leaves it unsigned with a note `--verbose` prints, unless the declaration
+ * sets `ci.green.signedSince`; then a run left unsigned is a warning.
+ *
+ * In place (`--in-place`, #4156) the job runs in the checkout it is started
+ * in, as a generated forge job does: no worktree, no setup phase and no
+ * commit status of its own (the forge shows the job). The steps get the
+ * job's whole environment less `CHANT_RUNNER_KEY`, since the forge job is
+ * already the boundary, and the record's `runOrigin` names the forge's run,
+ * job and attempt (`resolveCiJob`).
+ *
+ * Local (`--local`, #4161) runs the job the same way on this machine and
+ * leaves nothing outside it. It implies `--no-push` and `--no-status`, and
+ * writes nothing under a report URL, given or declared: the command gets no
+ * `--report-url`, and gets `--no-status`, so pr-plan and pr-apply post no
+ * status or note either. The record is still written to the local
+ * `chant/lifecycle`, where a reader on this machine finds it beside CI's for
+ * the same commit. It says `runOrigin: { forge: "local" }` and its events say
+ * `runtime: "local"`. `ci tick --source runs` and `ci list` never count it.
+ * A pr-apply still pushes its own release records and gate facts, as the
+ * command always does, since a local apply changes the same infrastructure
+ * a CI one does.
  */
 import { execFileSync } from "node:child_process";
 import { copyFileSync, cpSync, existsSync, mkdirSync, mkdtempSync, readdirSync, readFileSync, realpathSync, rmSync, writeFileSync } from "node:fs";
@@ -53,25 +77,38 @@ import { PR_APPLY_RECORD, PR_LOOP_REPORT_DIR, prLoopJobs, prLoopSetup, PR_LOOP_I
 import { detectForge, ForgeEnvironmentError, forgeFromEnv, FORGE_KINDS } from "../pr-forge.js";
 import { PR_APPLY_GATE } from "../pr-loop.js";
 import { formatError, formatWarning } from "../cli/format.js";
-import { pushLifecycleReport } from "../lifecycle/git.js";
+import { resolveCiJob } from "../lifecycle/release-ledger.js";
+import { fetchLifecycleStatus, pushLifecycleReport } from "../lifecycle/git.js";
 import { ACTIVITY_PROFILES } from "../op/activity-profiles.js";
 import { shellCmd } from "../op/activities/shell.js";
 import { OpRunFailure, runOpLocally } from "../op/local-executor.js";
 import { redactText } from "../op/redact.js";
 import { findWorkspaceRoot } from "../project-root.js";
 import { parseReportUrl, reportKey } from "../pr-report-url.js";
-import { ciTagSigner, RUNNER_KEY_ENV } from "./ci-green.js";
+import { reportUrlOf } from "./ci-report-url.js";
+import { ciTagSigner, RUNNER_KEY_ENV, signedRunsRequired } from "./ci-green.js";
+import { loadRunnerKey } from "./trust/dsse.js";
 import { ciRedactor, ciSecretsFor, CI_SECRETS_ENV, readCiSecrets } from "./ci-secrets.js";
 import { updateCiRunIndex } from "./ci-run-index.js";
 import { resolveMemberContext } from "./member-pipeline.js";
 import { signOpRunRecord } from "./trust/op-run-statement.js";
 import { gitTop } from "./tree.js";
 import { hostRunnerKey } from "./ci-runner-key.js";
-export const CI_JOB_NAMES = ["plan", "apply"];
+import { requireRunnerStart } from "./ci-runner-start.js";
+import { securityGroupsAt } from "./security.js";
+export const CI_JOB_NAMES = ["plan", "apply", "record"];
 /** The Op each job is recorded as, which `ci.green` phases match. */
-export const CI_JOB_OPS = { plan: "pr-plan", apply: "pr-apply" };
+export const CI_JOB_OPS = { plan: "pr-plan", apply: "pr-apply", record: "pr-record" };
+/** What each job's Op says it does. */
+const CI_JOB_OVERVIEWS = {
+    plan: "Plan the members this pull request reaches",
+    apply: "Apply the plan a reviewer approved",
+    record: "Record the plan on the merged commit; nothing applies",
+};
 /** Where a job the chant runner ran says it ran (#4094). */
 export const CHANT_RUNNER_ORIGIN = { forge: "chant" };
+/** Where a job `chant ci run --local` ran says it ran (#4161): this machine, outside CI. */
+export const CHANT_LOCAL_ORIGIN = { forge: "local" };
 /** The runner's variables every job gets, when the runner has them. */
 export const CI_RUN_BASE_ENV = ["PATH", "HOME", "USER", "LOGNAME", "SHELL", "LANG", "LC_ALL", "LC_CTYPE", "TMPDIR", "TZ"];
 /**
@@ -178,7 +215,7 @@ export function ciJobOp(input) {
     const op = CI_JOB_OPS[input.job.jobName];
     return {
         name: op,
-        overview: input.job.jobName === "plan" ? "Plan the members this pull request reaches" : "Apply the plan a reviewer approved",
+        overview: CI_JOB_OVERVIEWS[input.job.jobName],
         labels: { Env: input.env, Pipeline: "pr", Job: input.job.jobName },
         phases,
     };
@@ -190,6 +227,17 @@ function exitCodeOf(error) {
     const m = /command exited (\d+)/.exec(error ?? "");
     return m ? Number(m[1]) : undefined;
 }
+/**
+ * The code `chant ci run` exits with for a settled job: 0 when it passed,
+ * else its command's own code when that is 1 to 255, such as 3 for a moved
+ * plan or a waiting wave (#4156), else 1. The run index records the same
+ * code (#4165).
+ */
+export function ciJobExitCode(result) {
+    if (result.status === "ok")
+        return 0;
+    return result.exitCode && result.exitCode > 0 && result.exitCode < 256 ? result.exitCode : 1;
+}
 /** The first line of a step's error, for a reason. */
 const firstLine = (text) => text.split("\n").find((l) => l.trim() !== "")?.trim() ?? text;
 /**
@@ -249,12 +297,12 @@ export function ciJobFailure(input) {
 const STATUS_DESCRIPTION = 140;
 const cut = (text, max = STATUS_DESCRIPTION) => (text.length > max ? `${text.slice(0, max - 3)}...` : text);
 /**
- * A job's status context: `chant/pr-plan` for the plan, and for the apply
+ * A job's status context: `chant/pr-plan` for the plan, `chant/pr-record` for the record (#4168), and for the apply
  * `chant/<gate>`, which is `chant/pr-apply` unless `--gate` renamed the gate.
  * pr-plan's own status is `chant/plan` (../pr-loop.ts), a different context.
  */
 export function ciStatusContext(job, gate) {
-    return job === "apply" ? `chant/${gate ?? PR_APPLY_GATE}` : `chant/${CI_JOB_OPS.plan}`;
+    return job === "apply" ? `chant/${gate ?? PR_APPLY_GATE}` : `chant/${CI_JOB_OPS[job]}`;
 }
 /**
  * The link a job's status carries: the `--status-url` template with `{key}`
@@ -396,7 +444,9 @@ async function recordInIndex(input) {
         ended: input.record.ended,
         runId: clean(input.record.id),
         key: clean(reportKey(pr, input.commit, input.member)),
-        runOrigin: CHANT_RUNNER_ORIGIN,
+        runOrigin: input.runOrigin,
+        signer: input.signer,
+        exitCode: input.exitCode,
     };
     await updateCiRunIndex({ target, entry, ...(input.limit ? { limit: input.limit } : {}), warn: input.warn });
 }
@@ -413,12 +463,25 @@ export async function ciRun(req) {
     if (!top)
         throw new CiRunError("a job runs in a fresh checkout of a commit, and this directory is not in a git repository");
     const commit = resolveJobCommit(top, req.commit ?? "HEAD");
+    if (req.inPlace && commit !== resolveJobCommit(top, "HEAD"))
+        throw new CiRunError(`--in-place runs the checkout's HEAD, and --commit names ${commit.slice(0, 12)}`);
+    if (req.local && req.inPlace)
+        throw new CiRunError("--in-place runs a forge job in the forge's checkout, and --local runs one on this machine; pass one of them");
     const place = ciJobPlace(cwd, top);
-    const jobs = prLoopJobs(req.forge, req.env, req.loop ?? {}, place.member);
-    const job = jobs.find((j) => j.jobName === req.job);
-    if (!job)
+    const jobs = prLoopJobs(req.forge, req.env, req.local ? localLoop(req.loop) : (req.loop ?? {}), place.member);
+    const found = jobs.find((j) => j.jobName === req.job);
+    if (!found)
         throw new CiRunError(`the pull-request pipeline has no ${req.job} job; it has ${jobs.map((j) => j.jobName).join(" and ")}`);
-    const jobEnv = ciJobEnv(job, {
+    if (req.wave !== undefined && (req.job !== "apply" || !req.loop?.waveGate))
+        throw new CiRunError("--wave names the one wave an apply runs, and takes --wave-gate: ci run apply --wave-gate <gate> --wave <k>");
+    // #4147: before anything runs or any secret reaches a step, the provisioner's word that this runner was started for this job.
+    // #4168: under the isolated-runners security group an apply job requires the statement too, unless it runs on this machine.
+    const isolated = !req.requireRunnerStart && !req.local && req.job === "apply" && securityGroupsAt(cwd).has("isolated-runners");
+    const started = req.requireRunnerStart || isolated ? runnerStartFor(req, { top, commit, hostEnv }) : undefined;
+    // A generated wave job's command, as prLoopWaveJobs writes it. #4161: a local job's command posts no status or note.
+    const command = `${found.command}${req.wave !== undefined ? ` --wave ${req.wave}` : ""}${req.local ? " --no-status" : ""}`;
+    const job = { ...found, command, ...(req.wave !== undefined ? { wave: req.wave } : {}) };
+    const own = ciJobEnv(job, {
         forge: req.forge,
         env: req.env,
         values: { base: req.base, pr: req.pr, commit },
@@ -426,11 +489,16 @@ export async function ciRun(req) {
         passEnv: req.passEnv,
         secrets: ciSecretsFor(req.secrets, req.job),
     });
+    // #4156: in place, the forge job's environment is the job's, less the runner key.
+    const jobEnv = req.inPlace ? { ...definedEnv(hostEnv), ...own } : own;
+    delete jobEnv[RUNNER_KEY_ENV];
     // #4096: the secrets and the job's secret-looking variables, redacted from everything the run writes and returns.
-    const redact = ciRedactor(jobEnv, req.secrets);
+    // In place the forge's own variables come too; one whose value is short, such as a flag, is left out, so it can't blank common words.
+    const redact = ciRedactor(req.inPlace ? { ...longValues(jobEnv), ...own } : jobEnv, req.secrets);
     try {
-        const result = await runCiJob(req, { cwd, top, commit, place, job, jobEnv, ...(redact ? { redact } : {}) });
-        return redact ? { ...result, warnings: result.warnings.map(redact), ...(result.pushWarning ? { pushWarning: redact(result.pushWarning) } : {}) } : result;
+        const ran = await runCiJob(req, { cwd, top, commit, place, job, jobEnv, ...(redact ? { redact } : {}) });
+        const result = started ? { ...ran, notes: [started, ...ran.notes] } : ran;
+        return redact ? { ...result, warnings: result.warnings.map(redact), notes: result.notes.map(redact), ...(result.pushWarning ? { pushWarning: redact(result.pushWarning) } : {}) } : result;
     }
     catch (err) {
         if (redact && err instanceof Error)
@@ -438,23 +506,89 @@ export async function ciRun(req) {
         throw err;
     }
 }
+/**
+ * `--require-runner-start` (#4147): the runner-start statement for this
+ * forge job, checked against `.chant/trust.json` at `--base` (the commit
+ * before the change, as a push's `before` is), or at the job's commit
+ * without one. Throws {@link CiRunError} unless it verifies.
+ */
+function runnerStartFor(req, at) {
+    if (req.local)
+        throw new CiRunError("--require-runner-start checks a forge job's runner, and --local runs the job on this machine");
+    const base = req.base ? resolveJobCommit(at.top, req.base) : at.commit;
+    try {
+        return requireRunnerStart({ top: at.top, base, commit: at.commit, env: at.hostEnv }).reason;
+    }
+    catch (err) {
+        throw new CiRunError(message(err));
+    }
+}
+/** The generator's options for a `--local` job (#4161): the same, with no report URL. */
+function localLoop(loop) {
+    const { reportUrl: _dropped, ...rest } = loop ?? {};
+    return rest;
+}
+/** The variables of `env` whose value is long enough to be a credential, 8 characters or more. */
+function longValues(env) {
+    return Object.fromEntries(Object.entries(env).filter(([, value]) => value.length >= 8));
+}
+/** The variables of `env` that have a value. */
+function definedEnv(env) {
+    const out = {};
+    for (const [name, value] of Object.entries(env))
+        if (value !== undefined)
+            out[name] = value;
+    return out;
+}
+/**
+ * Who signs the run (#4156): the runner key, checked against
+ * `.chant/trust.json` at the commit. A key that isn't an Ed25519 PEM is an
+ * error, and so is a `--key` the file does not list. A key from the
+ * environment that it does not list, and no key at all, leave the run
+ * unsigned: a warning when the declaration's `ci.green.signedSince` asks
+ * for signed runs, a note for `--verbose` otherwise.
+ */
+function ciRunSigner(req, at) {
+    // #4161: a local run never counts, signed or not, so nothing about its signature warns.
+    const required = req.local ? null : signedRunsRequired(at.cwd);
+    const say = (text) => (required ? { warnings: [`${text}, and ci.green.signedSince is ${required}, so it will not count`], notes: [] } : { warnings: [], notes: [text] });
+    if (req.runnerKey === undefined)
+        return say("there is no runner key, so the run's record is unsigned");
+    try {
+        loadRunnerKey(req.runnerKey);
+    }
+    catch (err) {
+        throw new CiRunError(`the runner key${req.runnerKeyFromEnv ? ` in ${RUNNER_KEY_ENV}` : ""} is not an Ed25519 private key in PEM: ${message(err)}`);
+    }
+    try {
+        return { signer: ciTagSigner(at.top, at.commit, req.runnerKey, "the runs it signed"), warnings: [], notes: [] };
+    }
+    catch (err) {
+        if (!req.runnerKeyFromEnv)
+            throw new CiRunError(`the run would not be signed: ${message(err)}`);
+        return say(`${RUNNER_KEY_ENV} is set, and the run will not be signed: ${message(err)}`);
+    }
+}
+/** Where the job runs: a fresh worktree of the commit, or with `inPlace` the checkout itself, which is left as it is. */
+function jobCheckout(top, commit, inPlace) {
+    return inPlace ? { dir: top, remove() { } } : freshCheckout(top, commit);
+}
 /** {@link ciRun} once the job and its environment are known. */
 async function runCiJob(req, at) {
     const { cwd, top, commit, place, job, jobEnv, redact } = at;
-    // The record is signed against .chant/trust.json at the commit the job runs, so a key that commit does not list is refused before anything runs.
-    let signer;
-    const early = [];
-    if (req.runnerKey !== undefined) {
-        try {
-            signer = ciTagSigner(top, commit, req.runnerKey, "the runs it signed");
-        }
-        catch (err) {
-            if (!req.runnerKeyFromEnv)
-                throw new CiRunError(`the run would not be signed: ${message(err)}`);
-            early.push(`${RUNNER_KEY_ENV} is set, and the run will not be signed: ${message(err)}`);
-        }
-    }
-    const checkout = freshCheckout(top, commit);
+    const local = req.local === true;
+    const status = local ? undefined : req.status;
+    const reportUrl = local ? undefined : req.loop?.reportUrl;
+    // The record is signed against .chant/trust.json at the commit the job runs, so a --key that commit does not list is refused before anything runs.
+    const signing = ciRunSigner(req, { cwd, top, commit });
+    const signer = signing.signer;
+    const early = signing.warnings;
+    const notes = signing.notes;
+    const origin = local ? CHANT_LOCAL_ORIGIN : req.inPlace ? (resolveCiJob(req.hostEnv ?? process.env)?.runOrigin ?? CHANT_RUNNER_ORIGIN) : CHANT_RUNNER_ORIGIN;
+    // In place, the job writes its record on the checkout's chant/lifecycle, which a forge checkout may not have fetched.
+    if (req.inPlace && req.push !== false)
+        await fetchLifecycleStatus({ cwd: top }).catch(() => undefined);
+    const checkout = jobCheckout(top, commit, req.inPlace);
     try {
         const jobDir = place.dir === "." ? checkout.dir : join(checkout.dir, place.dir);
         const op = ciJobOp({
@@ -462,7 +596,7 @@ async function runCiJob(req, at) {
             env: req.env,
             cwd: jobDir,
             jobEnv,
-            setup: prLoopSetup(req.image ?? PR_LOOP_IMAGE),
+            setup: req.inPlace ? [] : prLoopSetup(req.image ?? PR_LOOP_IMAGE),
             build: [...(req.beforeScript ?? []), ...(job.build ?? [])],
             ...(req.chant ? { chant: req.chant } : {}),
         });
@@ -474,14 +608,14 @@ async function runCiJob(req, at) {
             copyFileSync(resume.host, resume.job);
         }
         const statusContext = ciStatusContext(req.job, req.loop?.gate);
-        const statusUrl = req.status
-            ? ciStatusUrl({ ...(req.status.urlTemplate ? { urlTemplate: req.status.urlTemplate } : {}), ...(req.loop?.reportUrl ? { reportUrl: req.loop.reportUrl } : {}), ...(req.pr !== undefined ? { pr: req.pr } : {}), commit, ...(place.member ? { member: place.member } : {}) })
+        const statusUrl = status
+            ? ciStatusUrl({ ...(status.urlTemplate ? { urlTemplate: status.urlTemplate } : {}), ...(reportUrl ? { reportUrl } : {}), ...(req.pr !== undefined ? { pr: req.pr } : {}), commit, ...(place.member ? { member: place.member } : {}) })
             : undefined;
         const postStatus = async (state, description) => {
-            if (!req.status)
+            if (!status)
                 return;
             try {
-                await req.status.client.setCommitStatus(commit, { context: statusContext, state, description: cut(redact ? redact(description) : description), ...(statusUrl ? { targetUrl: statusUrl } : {}) });
+                await status.client.setCommitStatus(commit, { context: statusContext, state, description: cut(redact ? redact(description) : description), ...(statusUrl ? { targetUrl: statusUrl } : {}) });
             }
             catch (err) {
                 warnings.push(`could not set the ${statusContext} status: ${message(err)}`);
@@ -498,7 +632,7 @@ async function runCiJob(req, at) {
                 cwd: jobDir,
                 commit,
                 ledger: { cwd: jobDir },
-                runner: { kind: "pipeline", runtime: "ci", runOrigin: CHANT_RUNNER_ORIGIN },
+                runner: { kind: "pipeline", runtime: local ? "local" : "ci", runOrigin: origin },
                 describeFailure: (records) => ciJobFailure({ job: req.job, op, records, reportDir: join(jobDir, PR_LOOP_REPORT_DIR) }),
                 ...(req.runEvents ? { runEvents: { write: req.runEvents } } : {}),
                 ...(req.stepOutput ? { stepOutput: req.stepOutput } : {}),
@@ -533,28 +667,40 @@ async function runCiJob(req, at) {
         let report = null;
         if (existsSync(written)) {
             report = resolve(cwd, req.output ?? PR_LOOP_REPORT_DIR);
-            cpSync(written, report, { recursive: true });
-            if (redact)
-                redactTree(report, redact);
+            // In place the report is already where the forge keeps it, and stays as the command wrote it.
+            if (!(existsSync(report) && realpathSync(report) === realpathSync(written))) {
+                cpSync(written, report, { recursive: true });
+                if (redact)
+                    redactTree(report, redact);
+            }
         }
-        if (req.loop?.reportUrl) {
-            await recordInIndex({ url: req.loop.reportUrl, job: req.job, commit, member: place.member, pr: req.pr, record: result.record, reportDir: written, limit: req.runIndexLimit, ...(redact ? { redact } : {}), warn: (w) => warnings.push(w) });
+        const failed = result.records.find((r) => r.status === "fail");
+        const exitCode = failed?.phase === req.job ? exitCodeOf(failed.error) : undefined;
+        if (reportUrl) {
+            await recordInIndex({ url: reportUrl, job: req.job, commit, member: place.member, pr: req.pr, record: result.record, runOrigin: origin, signer: result.record.statement && signer ? signer.principal : null, exitCode: ciJobExitCode({ status: result.status, ...(exitCode !== undefined ? { exitCode } : {}) }), reportDir: written, limit: req.runIndexLimit, ...(redact ? { redact } : {}), warn: (w) => warnings.push(w) });
         }
-        if (ledgerError)
+        // In place the forge job's outcome is the command's, so a record that could not be written is a warning there.
+        if (ledgerError && req.inPlace)
+            warnings.push(ledgerError);
+        else if (ledgerError)
             throw new CiRunError(ledgerError);
-        const pushed = req.push === false ? { pushed: false, pushWarning: "chant/lifecycle was not pushed" } : await pushLifecycleReport({ cwd: top });
-        const failed = result.records.find((r) => r.status === "fail");
+        const pushed = local
+            ? { pushed: false }
+            : req.push === false ? { pushed: false, pushWarning: "chant/lifecycle was not pushed" } : await pushLifecycleReport({ cwd: top });
         return {
             op: op.name,
             status: result.status,
             record: result.record,
             ...(failed ? { failure: { phase: failed.phase, error: failed.error ?? "the step failed" } } : {}),
+            ...(exitCode !== undefined ? { exitCode } : {}),
             report,
-            signer: signer?.principal ?? null,
+            signer: result.record.statement && signer ? signer.principal : null,
             pushed: pushed.pushed,
             ...(pushed.pushWarning ? { pushWarning: pushed.pushWarning } : {}),
             warnings,
+            notes,
             checkout: checkout.dir,
+            ...(local ? { local: true } : {}),
         };
     }
     finally {
@@ -592,18 +738,39 @@ export function formatCiRun(r) {
         lines.push(`  failure: ${why.code}${why.phase ? ` in ${why.phase}` : ""}${why.exitCode !== undefined ? `, exit ${why.exitCode}` : ""}: ${why.reason}`);
     else if (r.failure)
         lines.push(`  ${r.failure.phase}: ${r.failure.error}`);
-    lines.push(`  record: ${r.record.env}/runs__${r.op}.jsonl on chant/lifecycle, ${r.signer ? `signed by ${r.signer}` : "unsigned, so ci tick from runs does not count it"}`);
+    lines.push(`  record: ${r.record.env}/runs__${r.op}.jsonl on chant/lifecycle, ${r.signer ? `signed by ${r.signer}` : "unsigned"}`);
     if (r.report)
         lines.push(`  report: ${r.report}`);
-    if (!r.pushed)
+    if (r.local)
+        lines.push("  local run: the record stays on this machine, with no push, commit status or report upload");
+    else if (!r.pushed)
         lines.push(`  ${r.pushWarning ?? "chant/lifecycle was not pushed"}`);
     return lines.join("\n");
 }
 // ── The command ──────────────────────────────────────────────────────────────
-const USAGE = "chant ci run plan|apply --env <env> --base <sha> [--pr <n>] [--commit <sha>] [--forge github|gitlab|forgejo] " +
-    "[--gate <name>] [--branch <name>] [--events-json] [--report-url <url>] [--run-index-limit <n>] [--image <image>] [--before-script <line>]... " +
-    "[--pr-build] [--pr-build-command <line>] [--no-status] [--status-url <url template>] " +
-    "[--chant <command>] [--pass-env <NAME>]... [--secrets <file>] [--key <runner key.pem>] [-o <dir>] | chant ci run --setup-key [--trust [--principal <name>]] [--state <dir>] [--branch <name>]";
+/**
+ * The generator's options from `ci run`'s and `ci serve`'s flags, as `chant
+ * build --components --generate <lexicon> --pr-loop` takes them: `--gate`,
+ * `--branch`, `--events-json`, `--report-url`, `--pr-build`,
+ * `--pr-build-command`, `--wave-gate` (#4003) and `--require-review`
+ * (#4168; `--no-require-review`, the default, is still accepted).
+ */
+export function ciLoopOptions(args) {
+    return {
+        ...(args.gate ? { gate: args.gate } : {}),
+        ...(args.branch ? { branch: args.branch } : {}),
+        ...(args.eventsJson ? { events: true } : {}),
+        ...(args.reportUrl ? { reportUrl: args.reportUrl } : {}),
+        ...(args.prBuild ? { build: true } : {}),
+        ...(args.prBuildCommand ? { buildCommand: args.prBuildCommand } : {}),
+        ...(args.waveGate ? { waveGate: args.waveGate } : {}),
+        ...(args.requireReview === true ? { requireReview: true } : {}),
+    };
+}
+const USAGE = "chant ci run plan|record|apply --env <env> --base <sha> [--pr <n>] [--commit <sha>] [--forge github|gitlab|forgejo] " +
+    "[--gate <name>] [--wave-gate <name>] [--wave <k>] [--branch <name>] [--events-json] [--report-url <url>] [--run-index-limit <n>] [--image <image>] [--before-script <line>]... " +
+    "[--pr-build] [--pr-build-command <line>] [--require-review] [--no-status] [--status-url <url template>] " +
+    "[--chant <command>] [--pass-env <NAME>]... [--secrets <file>] [--key <runner key.pem>] [-o <dir>] [--in-place | --local] [--no-push] [--verbose] | chant ci run --at <sha> | chant ci run --setup-key [--trust [--principal <name>]] [--state <dir>] [--branch <name>]";
 const ENV_NAME = /^[A-Za-z_][A-Za-z0-9_]*$/;
 /** The host's runner key in `--state`, or in ci serve's default state directory, when `--setup-key` made one there (#4099). */
 function hostRunnerKeyAt(cwd, statePath) {
@@ -623,15 +790,40 @@ export function ciSecretsOf(flag, env = process.env) {
     const file = flag ?? (env[CI_SECRETS_ENV] || undefined);
     return file === undefined ? undefined : readCiSecrets(resolve(file));
 }
-/** `chant ci run plan|apply` (#4094). */
+/**
+ * `chant ci run --at <sha>` (#4169): ask for every required phase to be built
+ * at a commit of the green branch. On GitHub, with a token in the
+ * environment, the workflows holding the phases start at once.
+ */
+async function requestBuildCommand(at) {
+    const { requestBuild } = await import("./ci-green.js");
+    const { ciForgeFromEnv } = await import("./ci-green-forge.js");
+    let forge;
+    try {
+        forge = process.env.GITHUB_REPOSITORY ? ciForgeFromEnv("github") : undefined;
+    }
+    catch {
+        forge = undefined;
+    }
+    const r = await requestBuild({ cwd: process.cwd(), at, ...(forge ? { forge } : {}) });
+    for (const w of r.warnings)
+        console.error(formatWarning({ message: w }));
+    const what = `${r.request.phases.join(", ")} at ${r.request.commit.slice(0, 12)}`;
+    console.log(`${r.existed ? `${r.request.tag} already asks for a build` : `Asked for ${what}: ${r.request.tag}`}. ` +
+        (r.dispatched.length > 0 ? `Started ${r.dispatched.join(", ")}.` : "The next ci tick starts it on GitHub, and ci serve --build-command serves it for chant runs."));
+    return 0;
+}
+/** `chant ci run plan|record|apply` (#4094, #4168). */
 export async function runCiRun(ctx) {
     const { args } = ctx;
     try {
         if (args.setupKey)
             return (await import("./ci-serve.js")).runnerKeySetupCommand(ctx);
+        if (args.at !== undefined && args.extraPositional === undefined)
+            return await requestBuildCommand(args.at);
         const job = args.extraPositional;
-        if (job !== "plan" && job !== "apply")
-            throw new CiRunError(`ci run takes the job to run, plan or apply${job ? `, not ${JSON.stringify(job)}` : ""}`);
+        if (job !== "plan" && job !== "apply" && job !== "record")
+            throw new CiRunError(`ci run takes the job to run, plan, record or apply${job ? `, not ${JSON.stringify(job)}` : ""}`);
         if (!args.env)
             throw new CiRunError("--env names the environment the pipeline is for, as chant build --components --generate <lexicon> --pr-loop took it: --env <env>");
         const forge = args.forge ?? detectForge(process.env);
@@ -647,10 +839,14 @@ export async function runCiRun(ctx) {
         const hostKey = fromFlag || process.env[RUNNER_KEY_ENV] ? undefined : hostRunnerKeyAt(process.cwd(), args.statePath);
         const runnerKey = fromFlag ? readFileSync(resolve(args.key), "utf-8") : process.env[RUNNER_KEY_ENV] || hostKey?.pem;
         const hostEnv = process.env;
-        const { status, warning } = ciStatusFromEnv({ forge: forge, hostEnv, noStatus: args.noStatus, statusUrl: args.statusUrl });
+        // #4156: in place the forge shows the job, so ci run sets no status of its own.
+        // #4161: a local run sets no status, so it builds no client and warns about none.
+        const { status, warning } = ciStatusFromEnv({ forge: forge, hostEnv, noStatus: args.noStatus || args.ciInPlace || args.local, statusUrl: args.statusUrl });
         if (warning)
             console.error(formatWarning({ message: warning }));
         const secrets = ciSecretsOf(args.ciSecrets);
+        // #4160: without --report-url, the declaration's ci.reportUrl.
+        const reportUrl = await reportUrlOf(args.reportUrl, process.cwd());
         const result = await ciRun({
             cwd: process.cwd(),
             ...(status ? { status } : {}),
@@ -660,14 +856,12 @@ export async function runCiRun(ctx) {
             ...(args.base ? { base: args.base } : {}),
             ...(args.pr !== undefined ? { pr: args.pr } : {}),
             ...(args.commit ? { commit: args.commit } : {}),
-            loop: {
-                ...(args.gate ? { gate: args.gate } : {}),
-                ...(args.branch ? { branch: args.branch } : {}),
-                ...(args.eventsJson ? { events: true } : {}),
-                ...(args.reportUrl ? { reportUrl: args.reportUrl } : {}),
-                ...(args.prBuild ? { build: true } : {}),
-                ...(args.prBuildCommand ? { buildCommand: args.prBuildCommand } : {}),
-            },
+            loop: ciLoopOptions(reportUrl ? { ...args, reportUrl } : args),
+            ...(args.ciInPlace ? { inPlace: true } : {}),
+            ...(args.local ? { local: true } : {}),
+            ...(args.noPush ? { push: false } : {}),
+            ...(args.wave !== undefined ? { wave: args.wave } : {}),
+            ...(args.requireRunnerStart ? { requireRunnerStart: true } : {}),
             ...(args.runIndexLimit ? { runIndexLimit: args.runIndexLimit } : {}),
             ...(args.image ? { image: args.image } : {}),
             ...(args.beforeScript?.length ? { beforeScript: args.beforeScript } : {}),
@@ -681,8 +875,12 @@ export async function runCiRun(ctx) {
         });
         for (const w of result.warnings)
             console.error(formatWarning({ message: w }));
+        if (args.verbose)
+            for (const n of result.notes)
+                console.error(`ci run: ${n}`);
         console.error(formatCiRun(result));
-        return result.status === "ok" ? 0 : 1;
+        // #4156: a failed command's own exit code, such as 3 for a moved plan, is the job's, as it was before the job ran through ci run.
+        return ciJobExitCode(result);
     }
     catch (err) {
         console.error(formatError({ message: `chant ci run: ${message(err)}`, hint: USAGE }));

package/dist/workspace/ci-runner-key.d.ts

@@ -101,9 +101,18 @@ export declare function formatRunnerKeySetup(s: RunnerKeySetup, branch: string):
 /**
  * The key `ci serve` signs with, checked before its first poll (#4099): the
  * `--key` file, else `CHANT_RUNNER_KEY`, else the host's key in the state
- * directory. Throws, with the command that lists it, when there is none or
- * `.chant/trust.json` at the target's head does not list it with the runner
- * role. With `unsigned` there is no key and nothing is checked.
+ * directory. Signing is opt-in (#4156):
+ *
+ * - With no key, `ci serve` serves unsigned and says so only in `note`.
+ * - A key `.chant/trust.json` at the target's head does not list with the
+ *   runner role, or a target branch it can't find to check against, leaves
+ *   it serving unsigned, with one `warning`.
+ * - With `required` (the declaration's `ci.green.signedSince`) each of
+ *   those refuses to start, as before #4156.
+ *
+ * A key that is not an Ed25519 private key in PEM, or a `--key` file that
+ * can't be read, refuses either way. `unsigned` (`--unsigned`) skips the
+ * key without `required` and is ignored with it.
  */
 export declare function ciServeRunnerKey(req: {
     top: string;
@@ -112,9 +121,13 @@ export declare function ciServeRunnerKey(req: {
     keyFile?: string;
     envKey?: string;
     unsigned?: boolean;
+    /** The declaration's `ci.green.signedSince`, when it sets one: every run must then be signed. */
+    required?: string | null;
 }): {
     pem?: string;
     fromFlag: boolean;
     source: string;
+    warning?: string;
+    note?: string;
 };
 //# sourceMappingURL=ci-runner-key.d.ts.map

package/dist/workspace/ci-runner-key.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ci-runner-key.d.ts","sourceRoot":"","sources":["../../src/workspace/ci-runner-key.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAYH,oDAAoD;AACpD,eAAO,MAAM,eAAe,mBAAmB,CAAC;AAEhD,2FAA2F;AAC3F,wBAAgB,sBAAsB,IAAI,MAAM,CAE/C;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,OAAO,EAAE,OAAO,CAAC;CAClB;AA4BD,4EAA4E;AAC5E,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAGzE;AAED,yHAAyH;AACzH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa,CAWnE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,SAAW,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAOtH;AAED,gEAAgE;AAChE,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED,4HAA4H;AAC5H,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAMzI;AAED,MAAM,WAAW,mBAAmB;IAClC,mGAAmG;IACnG,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,mDAAmD;IACnD,MAAM,EAAE,OAAO,CAAC;IAChB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,mBAAmB,CAmChK;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,aAAa,CAAC;IACnB,4FAA4F;IAC5F,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,gEAAgE;IAChE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,mBAAmB,CAAC;CAChC;AAED,iIAAiI;AACjI,wBAAgB,cAAc,CAAC,GAAG,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,cAAc,CAQvJ;AAED,gFAAgF;AAChF,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAe9E;AAED;;;;;;GAMG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,CAAC,EAAE,OAAO,CAAA;CAAE,GAAG;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAwBnM"}
+{"version":3,"file":"ci-runner-key.d.ts","sourceRoot":"","sources":["../../src/workspace/ci-runner-key.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAYH,oDAAoD;AACpD,eAAO,MAAM,eAAe,mBAAmB,CAAC;AAEhD,2FAA2F;AAC3F,wBAAgB,sBAAsB,IAAI,MAAM,CAE/C;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,8BAA8B;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,iCAAiC;IACjC,OAAO,EAAE,OAAO,CAAC;CAClB;AA4BD,4EAA4E;AAC5E,wBAAgB,aAAa,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa,GAAG,SAAS,CAGzE;AAED,yHAAyH;AACzH,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,MAAM,GAAG,aAAa,CAWnE;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,SAAW,GAAG;IAAE,MAAM,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAOtH;AAED,gEAAgE;AAChE,wBAAgB,YAAY,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM,CAEzE;AAED,4HAA4H;AAC5H,wBAAgB,eAAe,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG;IAAE,EAAE,EAAE,IAAI,CAAC;IAAC,SAAS,EAAE,MAAM,CAAA;CAAE,GAAG;IAAE,EAAE,EAAE,KAAK,CAAC;IAAC,MAAM,EAAE,MAAM,CAAA;CAAE,CAMzI;AAED,MAAM,WAAW,mBAAmB;IAClC,mGAAmG;IACnG,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,mDAAmD;IACnD,MAAM,EAAE,OAAO,CAAC;IAChB,+CAA+C;IAC/C,MAAM,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED;;;;;;;;GAQG;AACH,wBAAgB,kBAAkB,CAAC,GAAG,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,SAAS,EAAE,MAAM,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,mBAAmB,CAmChK;AAED,MAAM,WAAW,cAAc;IAC7B,GAAG,EAAE,aAAa,CAAC;IACnB,4FAA4F;IAC5F,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IACpB,gEAAgE;IAChE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,mBAAmB,CAAC;CAChC;AAED,iIAAiI;AACjI,wBAAgB,cAAc,CAAC,GAAG,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,MAAM,CAAC;IAAC,KAAK,CAAC,EAAE,OAAO,CAAC;IAAC,EAAE,CAAC,EAAE,MAAM,CAAA;CAAE,GAAG,cAAc,CAQvJ;AAED,gFAAgF;AAChF,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,cAAc,EAAE,MAAM,EAAE,MAAM,GAAG,MAAM,CAe9E;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE;IACpC,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,iGAAiG;IACjG,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,GAAG;IAAE,GAAG,CAAC,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,CA+BvF"}

package/dist/workspace/ci-runner-key.js

@@ -184,18 +184,31 @@ export function formatRunnerKeySetup(s, branch) {
 /**
  * The key `ci serve` signs with, checked before its first poll (#4099): the
  * `--key` file, else `CHANT_RUNNER_KEY`, else the host's key in the state
- * directory. Throws, with the command that lists it, when there is none or
- * `.chant/trust.json` at the target's head does not list it with the runner
- * role. With `unsigned` there is no key and nothing is checked.
+ * directory. Signing is opt-in (#4156):
+ *
+ * - With no key, `ci serve` serves unsigned and says so only in `note`.
+ * - A key `.chant/trust.json` at the target's head does not list with the
+ *   runner role, or a target branch it can't find to check against, leaves
+ *   it serving unsigned, with one `warning`.
+ * - With `required` (the declaration's `ci.green.signedSince`) each of
+ *   those refuses to start, as before #4156.
+ *
+ * A key that is not an Ed25519 private key in PEM, or a `--key` file that
+ * can't be read, refuses either way. `unsigned` (`--unsigned`) skips the
+ * key without `required` and is ignored with it.
  */
 export function ciServeRunnerKey(req) {
-    if (req.unsigned)
-        return { fromFlag: false, source: "none (--unsigned)" };
+    const required = req.required ?? null;
+    const optIn = `ci.green.signedSince is ${required}, so every run must be signed`;
+    if (req.unsigned && !required)
+        return { fromFlag: false, source: "none (--unsigned)", note: "runs are not signed (--unsigned)" };
     const host = req.keyFile === undefined && !req.envKey ? hostRunnerKey(req.stateDir) : undefined;
     const pem = req.keyFile !== undefined ? readFileSync(req.keyFile, "utf-8") : req.envKey || host?.pem;
     const source = req.keyFile !== undefined ? req.keyFile : req.envKey ? "CHANT_RUNNER_KEY" : (host?.path ?? join(req.stateDir, RUNNER_KEY_FILE));
     if (pem === undefined) {
-        throw new CiRunError(`there is no runner key: no --key, no CHANT_RUNNER_KEY and no ${source}. Make one with chant ci serve --setup-key, list it with --trust, or start with --unsigned`);
+        if (!required)
+            return { fromFlag: false, source: "none", note: "runs are not signed: there is no runner key. To verify who ran a job, add one with chant ci serve --setup-key --trust" };
+        throw new CiRunError(`${optIn}, and there is no runner key: no --key, no CHANT_RUNNER_KEY and no ${source}. Make one with chant ci serve --setup-key and list it with --trust`);
     }
     let publicKey;
     try {
@@ -205,12 +218,19 @@ export function ciServeRunnerKey(req) {
         throw new CiRunError(`the runner key from ${source} is not an Ed25519 private key in PEM: ${message(err)}`);
     }
     const head = targetHead(req.top, req.branch);
-    if (!head)
-        throw new CiRunError(`there is no branch ${req.branch} here or on origin, so the runner key can't be checked against its .chant/trust.json; fetch it, or start with --unsigned`);
+    if (!head) {
+        const why = `there is no branch ${req.branch} here or on origin, so the runner key can't be checked against its .chant/trust.json`;
+        if (required)
+            throw new CiRunError(`${optIn}, and ${why}; fetch it`);
+        return { fromFlag: false, source, warning: `${why}, so runs are not signed; fetch it to sign them` };
+    }
     const listed = runnerKeyListed(req.top, head.commit, pem);
     if (!listed.ok) {
-        throw new CiRunError(`the runner key from ${source} is not trusted at ${branchAt(req.branch, head.commit)}: ${listed.reason}\n` +
-            `  List it on a branch for review with chant ci serve --setup-key --trust, or run ${trustCommand(defaultRunnerPrincipal(), publicKey)} in a checkout of ${req.branch} and merge the change. Start with --unsigned to serve without signing.`);
+        const why = `the runner key from ${source} is not trusted at ${branchAt(req.branch, head.commit)}: ${listed.reason}`;
+        const fix = `List it on a branch for review with chant ci serve --setup-key --trust, or run ${trustCommand(defaultRunnerPrincipal(), publicKey)} in a checkout of ${req.branch} and merge the change.`;
+        if (required)
+            throw new CiRunError(`${optIn}, and ${why}\n  ${fix}`);
+        return { fromFlag: false, source, warning: `${why}. Runs are not signed until it is. ${fix}` };
     }
     return { pem, fromFlag: req.keyFile !== undefined, source };
 }