@intentius/chant-lexicon-github 0.53.0 → 0.54.0

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

@@ -54,9 +54,24 @@ export type { GeneratedJob, GenerateGithubOptions, GenerateGithubResult };
  * apply its dialect transform + emit, rather than re-deriving the graph.
  */
 export interface GithubPipelineDoc {
+    /**
+     * The workflow's `name:` — `chant-components-<env>` (#2046), so two
+     * pipelines generated for two environments are tellable apart in the
+     * committed file, the Actions UI, and the API without lexing a job's
+     * `run:` line.
+     */
+    name: string;
+    /** The environment the pipeline deploys — `options.env` with the default applied (#2046). */
+    environment: string;
     /** The `on:` trigger mapping (a bare `workflow_dispatch`). */
     on: Record<string, unknown>;
-    /** The `env:` mapping, when `options.variables` is set. */
+    /**
+     * The `env:` mapping: the caller's `variables`, plus `CHANT_ENV` naming the
+     * deployed environment (#2046) — the machine-readable identity on the
+     * document itself. `CHANT_ENV` always reflects the environment baked into
+     * the run lines, so a caller-supplied variable of the same name cannot make
+     * the document lie about what its jobs deploy.
+     */
     env?: Record<string, unknown>;
     /** The `jobs:` mapping — one entry per component. */
     jobsDoc: Record<string, unknown>;

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

@@ -1 +1 @@
-{"version":3,"file":"generate-pipeline.d.ts","sourceRoot":"","sources":["../../src/components/generate-pipeline.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AAGH,OAAO,EAAyB,KAAK,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACjG,OAAO,KAAK,EACV,oBAAoB,IAAI,YAAY,EACpC,wBAAwB,IAAI,qBAAqB,EACjD,uBAAuB,IAAI,oBAAoB,EAChD,MAAM,0BAA0B,CAAC;AAElC,YAAY,EAAE,YAAY,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,CAAC;AAE1E;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC,8DAA8D;IAC9D,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5B,2DAA2D;IAC3D,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,uEAAuE;IACvE,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,0DAA0D;IAC1D,IAAI,EAAE,YAAY,EAAE,CAAC;CACtB;AAmBD;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,eAAe,EAAE,EAC7B,OAAO,GAAE,qBAA0B,GAClC,iBAAiB,CAwFnB;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,iBAAiB,GAAG,MAAM,CAQ/D;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,eAAe,EAAE,EAC7B,OAAO,GAAE,qBAA0B,GAClC,oBAAoB,CAGtB"}
+{"version":3,"file":"generate-pipeline.d.ts","sourceRoot":"","sources":["../../src/components/generate-pipeline.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA4CG;AAGH,OAAO,EAAyB,KAAK,eAAe,EAAE,MAAM,oCAAoC,CAAC;AACjG,OAAO,KAAK,EACV,oBAAoB,IAAI,YAAY,EACpC,wBAAwB,IAAI,qBAAqB,EACjD,uBAAuB,IAAI,oBAAoB,EAChD,MAAM,0BAA0B,CAAC;AAElC,YAAY,EAAE,YAAY,EAAE,qBAAqB,EAAE,oBAAoB,EAAE,CAAC;AAE1E;;;;;;GAMG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,6FAA6F;IAC7F,WAAW,EAAE,MAAM,CAAC;IACpB,8DAA8D;IAC9D,EAAE,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC5B;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IAC9B,qDAAqD;IACrD,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;IACjC,uEAAuE;IACvE,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,0DAA0D;IAC1D,IAAI,EAAE,YAAY,EAAE,CAAC;CACtB;AAmBD;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,eAAe,EAAE,EAC7B,OAAO,GAAE,qBAA0B,GAClC,iBAAiB,CA0FnB;AAED;;;GAGG;AACH,wBAAgB,gBAAgB,CAAC,GAAG,EAAE,iBAAiB,GAAG,MAAM,CAS/D;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,eAAe,EAAE,EAC7B,OAAO,GAAE,qBAA0B,GAClC,oBAAoB,CAGtB"}

package/dist/integrity.json

@@ -1,9 +1,9 @@
 {
   "algorithm": "sha256",
   "artifacts": {
-    "manifest.json": "1b94e4c8ea61d27b1e99e6e80aa3e9392cbfa6a255f213e9c4c78dabd9e221de",
+    "manifest.json": "8376a4151966d96884b6d16ad83e6727cf0a5daa33a1d83dc7cd799ca7d6585d",
     "meta.json": "dc3977afc2b6ddc4904de906d1b1e448b786b2aced9d82f8eade2ff915203344",
-    "types/index.d.ts": "1bd44e392981b8b0c01e4db9ca3a7ddb53782276d6210639f478af47241374a1",
+    "types/index.d.ts": "f207946d7ab52f712d0c09995366440a6bba8b39358057b0da38ff9c0acca429",
     "rules/deprecated-action-version.ts": "d41e6e532ab7f623af1bee4ac5279fcb2baada7defa1c5d022a5bc71983e8797",
     "rules/detect-secrets.ts": "5829832eb7b43993424971041ed386b196850183bffd34bddd6439f99061e4ae",
     "rules/extract-inline-structs.ts": "8f8147c200de8ffd0620dfdcca2e2cea76a520303ce431479ebecad6aa26aab5",
@@ -77,5 +77,5 @@
     "skills/chant-github-patterns.md": "bb3abef289a8fdfcf07d6bb2d7289dcb2f38bc0cb0321ea320b78b45a6f548c0",
     "skills/chant-github-security.md": "aab111cb0871cad30281ce48d7da23663689619351029219e2be019a1a61e394"
   },
-  "composite": "03817a7e6869e374379753d1ffa793d31be96c9a4d0ad775ccdee5fdd7388f49"
+  "composite": "6608b4fcff3858c45f340b5bb75d09242b60ff117cb48a50a47af98d08b201b0"
 }

package/dist/manifest.json

@@ -1,6 +1,6 @@
 {
   "name": "github",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "chantVersion": ">=0.1.0",
   "namespace": "GitHub",
   "intrinsics": [

package/dist/okf/types/ReusableWorkflowCallJob.md

@@ -12,7 +12,7 @@ resource_type: GitHub::Actions::ReusableWorkflowCallJob
 
 - `uses` (`string`, required): The location and version of a reusable workflow file to run as a job, of the form './{path/to}/{localfile}.yml' or '{owner}/{repo}/{path}/{filename}@{ref}'. {ref} can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security.
 - `concurrency` (`string | Record<string, any>`, optional): Concurrency ensures that only a single job or workflow using the same concurrency group will run at a time. A concurrency group can be any string or expression. The expression can use any context except for the secrets context. You can also specify concurrency at the workflow level. When a concurrent job or workflow is queued, if another job or workflow using the same concurrency group in the repository is in progress, the queued job or workflow will be pending. By default any previously pending job or workflow in the concurrency group will be canceled; this behavior can be changed with `queue`. To also cancel any currently running job or workflow in the same concurrency group, specify cancel-in-progress: true.
-- `if` (`boolean`, optional): You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional. Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.
+- `if` (`boolean | number | string`, optional): You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional. Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions.
 - `name` (`string`, optional): The name of the job displayed on GitHub.
 - `needs` (`any`, optional)
 - `permissions` (`any`, optional)

package/dist/types/index.d.ts

@@ -163,7 +163,7 @@ When a concurrent job or workflow is queued, if another job or workflow using th
     concurrency?: string | Record<string, any>;
     /** You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.
 Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. */
-    if?: boolean;
+    if?: boolean | number | string;
     /** The name of the job displayed on GitHub. */
     name?: string;
     needs?: any;
@@ -227,9 +227,9 @@ export declare class Strategy {
   constructor(props: {
     matrix: Record<string, unknown>;
     /** When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true */
-    "fail-fast"?: boolean;
+    "fail-fast"?: boolean | string;
     /** The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines. */
-    "max-parallel"?: number;
+    "max-parallel"?: number | string;
   });
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intentius/chant-lexicon-github",
-  "version": "0.53.0",
+  "version": "0.54.0",
   "description": "GitHub Actions lexicon for chant — declarative IaC in TypeScript",
   "license": "Apache-2.0",
   "homepage": "https://intentius.io/chant",
@@ -61,7 +61,7 @@
     "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@intentius/chant": "^0.53.0",
+    "@intentius/chant": "^0.54.0",
     "typescript": "^5.9.3"
   }
 }

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

@@ -249,18 +249,36 @@ describe("generateGithubPipeline: a cross-cutting change is one generator edit,
 });
 
 describe("generateGithubPipeline: options", () => {
-  test("emits a top-level env: block when variables are provided", () => {
+  test("merges caller variables into the env: block alongside CHANT_ENV", () => {
     const result = generateGithubPipeline(pilotComponents(), {
-      variables: { CHANT_ENV: "staging" },
+      env: "staging",
+      variables: { AWS_REGION: "eu-west-1" },
     });
     const parsed = parseYAML(result.yaml);
-    expect(parsed.env).toEqual({ CHANT_ENV: "staging" });
+    expect(parsed.env).toEqual({ AWS_REGION: "eu-west-1", CHANT_ENV: "staging" });
   });
 
-  test("omits the env: block when no variables are provided", () => {
-    const result = generateGithubPipeline(pilotComponents());
-    const parsed = parseYAML(result.yaml);
-    expect(parsed.env).toBeUndefined();
+  test("the document carries its environment identity: name + CHANT_ENV (#2046)", () => {
+    const staging = generateGithubPipeline(pilotComponents(), { env: "staging" });
+    const prod = generateGithubPipeline(pilotComponents());
+
+    // Two environments' workflows are tellable apart without lexing a run: line.
+    expect(parseYAML(staging.yaml).name).toBe("chant-components-staging");
+    expect(parseYAML(prod.yaml).name).toBe("chant-components-production");
+    expect(parseYAML(staging.yaml).env).toEqual({ CHANT_ENV: "staging" });
+    expect(parseYAML(prod.yaml).env).toEqual({ CHANT_ENV: "production" });
+
+    // And the machine-readable result names it too.
+    expect(staging.env).toBe("staging");
+    expect(prod.env).toBe("production");
+  });
+
+  test("CHANT_ENV always reflects the environment baked into the run lines — a caller variable cannot override it", () => {
+    const result = generateGithubPipeline(pilotComponents(), {
+      env: "staging",
+      variables: { CHANT_ENV: "prod" },
+    });
+    expect((parseYAML(result.yaml).env as Record<string, unknown>).CHANT_ENV).toBe("staging");
   });
 
   test("uses a custom container image for every job when provided", () => {

package/src/components/generate-pipeline.ts

@@ -62,9 +62,24 @@ export type { GeneratedJob, GenerateGithubOptions, GenerateGithubResult };
  * apply its dialect transform + emit, rather than re-deriving the graph.
  */
 export interface GithubPipelineDoc {
+  /**
+   * The workflow's `name:` — `chant-components-<env>` (#2046), so two
+   * pipelines generated for two environments are tellable apart in the
+   * committed file, the Actions UI, and the API without lexing a job's
+   * `run:` line.
+   */
+  name: string;
+  /** The environment the pipeline deploys — `options.env` with the default applied (#2046). */
+  environment: string;
   /** The `on:` trigger mapping (a bare `workflow_dispatch`). */
   on: Record<string, unknown>;
-  /** The `env:` mapping, when `options.variables` is set. */
+  /**
+   * The `env:` mapping: the caller's `variables`, plus `CHANT_ENV` naming the
+   * deployed environment (#2046) — the machine-readable identity on the
+   * document itself. `CHANT_ENV` always reflects the environment baked into
+   * the run lines, so a caller-supplied variable of the same name cannot make
+   * the document lie about what its jobs deploy.
+   */
   env?: Record<string, unknown>;
   /** The `jobs:` mapping — one entry per component. */
   jobsDoc: Record<string, unknown>;
@@ -185,8 +200,10 @@ export function buildGithubPipelineDoc(
   });
 
   return {
+    name: `chant-components-${env}`,
+    environment: env,
     on: { workflow_dispatch: {} },
-    ...(options.variables && Object.keys(options.variables).length > 0 ? { env: options.variables } : {}),
+    env: { ...options.variables, CHANT_ENV: env },
     jobsDoc,
     stages,
     jobs,
@@ -199,6 +216,7 @@ export function buildGithubPipelineDoc(
  */
 export function emitPipelineYAML(doc: GithubPipelineDoc): string {
   const sections: string[] = [];
+  sections.push("name: " + emitYAML(doc.name, 0));
   sections.push("on:" + emitYAML(doc.on, 1));
   if (doc.env && Object.keys(doc.env).length > 0) {
     sections.push("env:" + emitYAML(doc.env, 1));
@@ -218,5 +236,5 @@ export function generateGithubPipeline(
   options: GenerateGithubOptions = {},
 ): GenerateGithubResult {
   const doc = buildGithubPipelineDoc(components, options);
-  return { yaml: emitPipelineYAML(doc), stages: doc.stages, jobs: doc.jobs };
+  return { yaml: emitPipelineYAML(doc), stages: doc.stages, jobs: doc.jobs, env: doc.environment };
 }

package/src/generated/index.d.ts

@@ -163,7 +163,7 @@ When a concurrent job or workflow is queued, if another job or workflow using th
     concurrency?: string | Record<string, any>;
     /** You can use the if conditional to prevent a job from running unless a condition is met. You can use any supported context and expression to create a conditional.
 Expressions in an if conditional do not require the ${{ }} syntax. For more information, see https://help.github.com/en/articles/contexts-and-expression-syntax-for-github-actions. */
-    if?: boolean;
+    if?: boolean | number | string;
     /** The name of the job displayed on GitHub. */
     name?: string;
     needs?: any;
@@ -227,9 +227,9 @@ export declare class Strategy {
   constructor(props: {
     matrix: Record<string, unknown>;
     /** When set to true, GitHub cancels all in-progress jobs if any matrix job fails. Default: true */
-    "fail-fast"?: boolean;
+    "fail-fast"?: boolean | string;
     /** The maximum number of jobs that can run simultaneously when using a matrix job strategy. By default, GitHub will maximize the number of jobs run in parallel depending on the available runners on GitHub-hosted virtual machines. */
-    "max-parallel"?: number;
+    "max-parallel"?: number | string;
   });
 }