@intentius/chant-lexicon-gitlab 0.116.0 → 0.118.0

package/dist/components/generate-op-waves-pipeline.d.ts

@@ -9,6 +9,15 @@
  * decision as an artifact, which GitLab hands each share job through `needs:`.
  * A wave's `environment` is the job's own `environment:`; protect it in the
  * project settings to put a reviewer in front of the job as well.
+ *
+ * With `resume` on the spec (#3683), a `<name>-resume` job runs `chant run
+ * resume --op <name>` in scheduled pipelines only: create a pipeline schedule
+ * with the spec's cron. It retries a waiting wave's job once its approval
+ * arrived, with `CHANT_FORGE_TOKEN` (a project access token with the `api`
+ * scope and the Developer role; the job token cannot retry jobs).
+ *
+ * A `pr-review` wave (#3684) adds `<name>-record-plans`, run in merge request
+ * pipelines only, which records the digests the merge request's head plans.
  */
 import { type OpWavesSpec } from "@intentius/chant/op/op-waves";
 import type { OpWavesPipelineOptions, OpWavesPipelineResult } from "@intentius/chant/lexicon";

package/dist/components/generate-op-waves-pipeline.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"generate-op-waves-pipeline.d.ts","sourceRoot":"","sources":["../../src/components/generate-op-waves-pipeline.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;GAWG;AAGH,OAAO,EAAc,KAAK,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAC5E,OAAO,KAAK,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAK9F,gHAAgH;AAChH,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,sBAAsB,GAAG,qBAAqB,CAgDvH"}
+{"version":3,"file":"generate-op-waves-pipeline.d.ts","sourceRoot":"","sources":["../../src/components/generate-op-waves-pipeline.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;GAoBG;AAGH,OAAO,EAAoC,KAAK,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAClG,OAAO,KAAK,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,0BAA0B,CAAC;AAK9F,gHAAgH;AAChH,wBAAgB,6BAA6B,CAAC,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,sBAAsB,GAAG,qBAAqB,CA4EvH"}

package/dist/integrity.json

@@ -1,7 +1,7 @@
 {
   "algorithm": "sha256",
   "artifacts": {
-    "manifest.json": "5dbd479adbef7ff3f5f78326a864313f31bc59e0bc68e6f1ced8bcc3a9213624",
+    "manifest.json": "598869766c3821ca4fdf25bbd91ade4e8957542e0694373764d3f8d7120a0cdb",
     "meta.json": "931fc3246a55645b1493080bbeb160e5d205e42349e8bdca96ca243adb5f0da3",
     "types/index.d.ts": "5cd2e99f135a929b72bdd822d00d780d39b1cd407ba0cfb3d511c7ac9d667b58",
     "rules/artifact-no-expiry.ts": "3f3cabf9792cbf8207e53a25f506715466b19ec25e9c3b4d0d77fed6b2eb4542",
@@ -55,5 +55,5 @@
     "skills/chant-gitlab-migrate.md": "4853d04980560b379e5b0f7267dcb0a1e5d5879cb9e9931681ce76b2a5fe69d8",
     "skills/chant-gitlab-patterns.md": "6d9a44e9e8de4c3820be9d65381b0d2ede4cb3626aaaf0011e21838a9fbf556e"
   },
-  "composite": "5de94034f8a25bce4e7534039b13e564518784255b770f1281849cb5a0821294"
+  "composite": "9f524e8c727cefaf1e1cf3d24a63928defc3a947f3a7dbc44a396c7d90d0f36f"
 }

package/dist/manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "gitlab",
-  "version": "0.116.0",
+  "version": "0.118.0",
   "chantVersion": ">=0.1.0",
   "namespace": "GitLab",
   "intrinsics": [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intentius/chant-lexicon-gitlab",
-  "version": "0.116.0",
+  "version": "0.118.0",
   "description": "GitLab CI lexicon for chant — declarative IaC in TypeScript",
   "license": "Apache-2.0",
   "homepage": "https://intentius.io/chant",
@@ -67,8 +67,8 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@intentius/chant": "^0.116.0",
-    "@intentius/chant-lexicon-github": "^0.116.0",
+    "@intentius/chant": "^0.118.0",
+    "@intentius/chant-lexicon-github": "^0.118.0",
     "typescript": "^5.9.3"
   },
   "peerDependenciesMeta": {

package/src/components/generate-op-waves-pipeline.test.ts

@@ -26,4 +26,22 @@ describe("generateGitlabOpWavesPipeline", () => {
     expect(yaml).toContain("- .chant/op-waves/migrations/wave-2.json");
     expect(yaml).toContain("environment:\n    name: production");
   });
+
+  test("resume renders a job that runs only in scheduled pipelines (#3683)", () => {
+    const { files } = generateGitlabOpWavesPipeline({ ...spec, resume: { schedule: "*/10 * * * *" } }, { specFile: "waves.json" });
+    const yaml = files[0]!.yaml;
+    expect(yaml).toContain(`${spec.name}-resume:`);
+    expect(yaml).toContain('$CI_PIPELINE_SOURCE == "schedule"');
+    expect(yaml).toContain(`chant run resume --op ${spec.name}`);
+    expect(yaml).toContain('give the schedule the cron "*/10 * * * *"');
+    expect(generateGitlabOpWavesPipeline(spec, { specFile: "waves.json" }).files[0]!.yaml).not.toContain("resume");
+  });
+
+  test("a pr-review wave adds a merge request job that records the head's plans (#3684)", () => {
+    const yaml = generateGitlabOpWavesPipeline({ ...spec, waves: spec.waves.map((w, i) => (i === spec.waves.length - 1 ? { ...w, approval: "pr-review" as const } : w)) }, { specFile: "waves.json" }).files[0]!.yaml;
+    expect(yaml).toContain(`${spec.name}-record-plans:`);
+    expect(yaml).toContain('$CI_PIPELINE_SOURCE == "merge_request_event"');
+    expect(yaml).toContain("chant run wave --spec waves.json --record-plans");
+    expect(yaml).toMatch(/stages:\n\s+- plans\n/);
+  });
 });

package/src/components/generate-op-waves-pipeline.ts

@@ -9,10 +9,19 @@
  * decision as an artifact, which GitLab hands each share job through `needs:`.
  * A wave's `environment` is the job's own `environment:`; protect it in the
  * project settings to put a reviewer in front of the job as well.
+ *
+ * With `resume` on the spec (#3683), a `<name>-resume` job runs `chant run
+ * resume --op <name>` in scheduled pipelines only: create a pipeline schedule
+ * with the spec's cron. It retries a waiting wave's job once its approval
+ * arrived, with `CHANT_FORGE_TOKEN` (a project access token with the `api`
+ * scope and the Developer role; the job token cannot retry jobs).
+ *
+ * A `pr-review` wave (#3684) adds `<name>-record-plans`, run in merge request
+ * pipelines only, which records the digests the merge request's head plans.
  */
 
 import { emitYAMLEntry } from "@intentius/chant/yaml";
-import { opWaveJobs, type OpWavesSpec } from "@intentius/chant/op/op-waves";
+import { opWaveJobs, opWavesResumeCommand, type OpWavesSpec } from "@intentius/chant/op/op-waves";
 import type { OpWavesPipelineOptions, OpWavesPipelineResult } from "@intentius/chant/lexicon";
 
 /** The default image: it carries git, which the runner needs to read the base commit. */
@@ -30,7 +39,9 @@ export function generateGitlabOpWavesPipeline(spec: OpWavesSpec, options: OpWave
   }
   const rules = branches.map((branch) => ({ if: `$CI_PIPELINE_SOURCE == "push" && $CI_COMMIT_BRANCH == "${branch}"` }));
 
-  const stages = spec.waves.map((wave, i) => `wave-${i + 1}-${wave.name}`);
+  const byReview = spec.waves.some((w) => w.approval === "pr-review");
+  const stages = [...(byReview ? ["plans"] : []), ...spec.waves.map((wave, i) => `wave-${i + 1}-${wave.name}`)];
+  if (spec.resume) stages.push("resume");
   const sections: string[] = [emitYAMLEntry("stages", stages)];
   if (options.variables && Object.keys(options.variables).length > 0) sections.push(emitYAMLEntry("variables", options.variables));
   for (const job of jobs) {
@@ -46,7 +57,7 @@ export function generateGitlabOpWavesPipeline(spec: OpWavesSpec, options: OpWave
     });
     sections.push(
       emitYAMLEntry(job.jobName, {
-        stage: stages[job.wave - 1],
+        stage: stages[job.wave - 1 + (byReview ? 1 : 0)],
         image,
         resource_group: `${spec.name}-${wave.name}`,
         ...(wave.environment
@@ -60,10 +71,36 @@ export function generateGitlabOpWavesPipeline(spec: OpWavesSpec, options: OpWave
       }),
     );
   }
+  if (spec.resume) {
+    sections.push(
+      emitYAMLEntry(`${spec.name}-resume`, {
+        stage: "resume",
+        image,
+        rules: [{ if: '$CI_PIPELINE_SOURCE == "schedule"' }],
+        script: [...(options.beforeScript ?? []), opWavesResumeCommand(spec).join(" ")],
+      }),
+    );
+  }
+  if (byReview) {
+    sections.splice(
+      options.variables && Object.keys(options.variables).length > 0 ? 2 : 1,
+      0,
+      emitYAMLEntry(`${spec.name}-record-plans`, {
+        stage: "plans",
+        image,
+        variables: { GIT_DEPTH: "0" },
+        rules: [{ if: '$CI_PIPELINE_SOURCE == "merge_request_event"' }],
+        script: [...(options.beforeScript ?? []), ["chant", "run", "wave", "--spec", options.specFile, "--record-plans"].join(" ")],
+      }),
+    );
+  }
   const header = [
     `# chant Op waves "${spec.name}" (#3679): one stage per wave, each needing the one before.`,
     "# A wave that waits at its gate exits 3 and stops the waves after it; approve the",
     "# digest it prints, then retry the job.",
+    ...(spec.resume
+      ? [`# The ${spec.name}-resume job retries it for you in a pipeline schedule; give the schedule the cron "${spec.resume.schedule}".`]
+      : []),
   ];
   const name = options.opsFileName ?? `${spec.name}.gitlab-ci.yml`;
   return { files: [{ name, yaml: header.join("\n") + "\n\n" + sections.join("\n\n") + "\n" }], jobs };