@intentius/chant-lexicon-github 0.18.19 → 0.18.21

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

@@ -46,6 +46,25 @@
 import { type DriverComponent } from "@intentius/chant/components/driver";
 import type { ComponentPipelineJob as GeneratedJob, ComponentPipelineOptions as GenerateGithubOptions, ComponentPipelineResult as GenerateGithubResult } from "@intentius/chant/lexicon";
 export type { GeneratedJob, GenerateGithubOptions, GenerateGithubResult };
+/**
+ * The structured pipeline document behind {@link generateGithubPipeline}: the
+ * `on`/`env`/`jobs` mappings plus the machine-readable `stages`/`jobs` views,
+ * before YAML emission. Exposed so a GitHub-Actions dialect (the forgejo
+ * lexicon, #969) can reuse the exact job/`needs:`/artifact structure and only
+ * apply its dialect transform + emit, rather than re-deriving the graph.
+ */
+export interface GithubPipelineDoc {
+    /** The `on:` trigger mapping (a bare `workflow_dispatch`). */
+    on: Record<string, unknown>;
+    /** The `env:` mapping, when `options.variables` is set. */
+    env?: Record<string, unknown>;
+    /** The `jobs:` mapping — one entry per component. */
+    jobsDoc: Record<string, unknown>;
+    /** Wave-ordered stage names (parity with gitlab's `--format json`). */
+    stages: string[];
+    /** Every generated job, for the machine-readable view. */
+    jobs: GeneratedJob[];
+}
 /**
  * Synthesize a `.github/workflows/*.yml` pipeline from a set of components:
  * one job per component, `needs:` expressing the wave-ordered dependency DAG
@@ -55,5 +74,17 @@ export type { GeneratedJob, GenerateGithubOptions, GenerateGithubResult };
  * resolution. Wired into core's generate mode via the github lexicon plugin's
  * `generateComponentPipeline` (../plugin.ts).
  */
+export declare function buildGithubPipelineDoc(components: DriverComponent[], options?: GenerateGithubOptions): GithubPipelineDoc;
+/**
+ * Emit a `GithubPipelineDoc`'s `on`/`env`/`jobs` mappings as workflow YAML.
+ * Shared with the forgejo dialect (#969), which transforms the doc first.
+ */
+export declare function emitPipelineYAML(doc: GithubPipelineDoc): string;
+/**
+ * Synthesize a `.github/workflows/*.yml` pipeline from a set of components:
+ * one job per component, `needs:` expressing the wave-ordered dependency DAG
+ * from `resolveComponentGraph`. Thin wrapper over {@link buildGithubPipelineDoc}
+ * + {@link emitPipelineYAML}.
+ */
 export declare function generateGithubPipeline(components: DriverComponent[], options?: GenerateGithubOptions): GenerateGithubResult;
 //# sourceMappingURL=generate-pipeline.d.ts.map

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;AAmB1E;;;;;;;;GAQG;AACH,wBAAgB,sBAAsB,CACpC,UAAU,EAAE,eAAe,EAAE,EAC7B,OAAO,GAAE,qBAA0B,GAClC,oBAAoB,CAyFtB"}
+{"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"}

package/dist/integrity.json

@@ -1,7 +1,7 @@
 {
   "algorithm": "sha256",
   "artifacts": {
-    "manifest.json": "d280f4b331d5ab4d23b5fcce3510764b5daffa2a5cac1e00673607e3aac17dc6",
+    "manifest.json": "58de7bb44695722c5954dafd959a6f54b377bb3e5062fb3d6faac0e1cbd8bccc",
     "meta.json": "798c5f5f37b0174756d2451299acfdc95c014f11d06d32b9153bbdfa9f3a580c",
     "types/index.d.ts": "39c0791f0e58025bcef82e0f7a92240508f899fc2771d5dd51b2369b4d330f13",
     "rules/deprecated-action-version.ts": "d41e6e532ab7f623af1bee4ac5279fcb2baada7defa1c5d022a5bc71983e8797",
@@ -67,5 +67,5 @@
     "skills/chant-github-patterns.md": "bb3abef289a8fdfcf07d6bb2d7289dcb2f38bc0cb0321ea320b78b45a6f548c0",
     "skills/chant-github-security.md": "aab111cb0871cad30281ce48d7da23663689619351029219e2be019a1a61e394"
   },
-  "composite": "24938b2489e4595d35ebde3c54d502f59e7cff165c9ed5fb45af74c195f4ea4d"
+  "composite": "f1894e66a85587a72cf0e0c37ea25e889d17d3a2a7bb9d6f3f66332d1761e911"
 }

package/dist/manifest.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@intentius/chant-lexicon-github",
-  "version": "0.18.19",
+  "version": "0.18.21",
   "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.18.19",
+    "@intentius/chant": "^0.18.21",
     "typescript": "^5.9.3"
   }
 }

package/src/components/generate-pipeline.ts

@@ -54,6 +54,26 @@ import type {
 
 export type { GeneratedJob, GenerateGithubOptions, GenerateGithubResult };
 
+/**
+ * The structured pipeline document behind {@link generateGithubPipeline}: the
+ * `on`/`env`/`jobs` mappings plus the machine-readable `stages`/`jobs` views,
+ * before YAML emission. Exposed so a GitHub-Actions dialect (the forgejo
+ * lexicon, #969) can reuse the exact job/`needs:`/artifact structure and only
+ * apply its dialect transform + emit, rather than re-deriving the graph.
+ */
+export interface GithubPipelineDoc {
+  /** The `on:` trigger mapping (a bare `workflow_dispatch`). */
+  on: Record<string, unknown>;
+  /** The `env:` mapping, when `options.variables` is set. */
+  env?: Record<string, unknown>;
+  /** The `jobs:` mapping — one entry per component. */
+  jobsDoc: Record<string, unknown>;
+  /** Wave-ordered stage names (parity with gitlab's `--format json`). */
+  stages: string[];
+  /** Every generated job, for the machine-readable view. */
+  jobs: GeneratedJob[];
+}
+
 /** GitHub Actions job ids must match `[a-zA-Z_][a-zA-Z0-9_-]*`; component names are already kebab-case in every fixture, but normalize defensively (mirrors gitlab's `toJobName`). */
 function toJobName(componentName: string): string {
   return componentName.replace(/([a-z0-9])([A-Z])/g, "$1-$2").toLowerCase();
@@ -80,10 +100,10 @@ function artifactName(name: string): string {
  * resolution. Wired into core's generate mode via the github lexicon plugin's
  * `generateComponentPipeline` (../plugin.ts).
  */
-export function generateGithubPipeline(
+export function buildGithubPipelineDoc(
   components: DriverComponent[],
   options: GenerateGithubOptions = {},
-): GenerateGithubResult {
+): GithubPipelineDoc {
   const env = options.env ?? "production";
   const image = options.image ?? DEFAULT_IMAGE;
   const runCommand = options.runCommand ?? ["chant", "run", "--components", "{name}", "--env", env];
@@ -164,12 +184,39 @@ export function generateGithubPipeline(
     }
   });
 
+  return {
+    on: { workflow_dispatch: {} },
+    ...(options.variables && Object.keys(options.variables).length > 0 ? { env: options.variables } : {}),
+    jobsDoc,
+    stages,
+    jobs,
+  };
+}
+
+/**
+ * Emit a `GithubPipelineDoc`'s `on`/`env`/`jobs` mappings as workflow YAML.
+ * Shared with the forgejo dialect (#969), which transforms the doc first.
+ */
+export function emitPipelineYAML(doc: GithubPipelineDoc): string {
   const sections: string[] = [];
-  sections.push("on:" + emitYAML({ workflow_dispatch: {} }, 1));
-  if (options.variables && Object.keys(options.variables).length > 0) {
-    sections.push("env:" + emitYAML(options.variables, 1));
+  sections.push("on:" + emitYAML(doc.on, 1));
+  if (doc.env && Object.keys(doc.env).length > 0) {
+    sections.push("env:" + emitYAML(doc.env, 1));
   }
-  sections.push("jobs:" + emitYAML(jobsDoc, 1));
+  sections.push("jobs:" + emitYAML(doc.jobsDoc, 1));
+  return sections.join("\n\n") + "\n";
+}
 
-  return { yaml: sections.join("\n\n") + "\n", stages, jobs };
+/**
+ * Synthesize a `.github/workflows/*.yml` pipeline from a set of components:
+ * one job per component, `needs:` expressing the wave-ordered dependency DAG
+ * from `resolveComponentGraph`. Thin wrapper over {@link buildGithubPipelineDoc}
+ * + {@link emitPipelineYAML}.
+ */
+export function generateGithubPipeline(
+  components: DriverComponent[],
+  options: GenerateGithubOptions = {},
+): GenerateGithubResult {
+  const doc = buildGithubPipelineDoc(components, options);
+  return { yaml: emitPipelineYAML(doc), stages: doc.stages, jobs: doc.jobs };
 }