@catladder/cli 0.0.0-next-e7541a00 → 0.0.0-next-4e7c6848

package/dist/cli/src/apps/catenv/catenv.js

@@ -10,7 +10,6 @@ const writeDotEnvFiles_1 = require("./writeDotEnvFiles");
 const writeEnvDTs_1 = require("./writeEnvDTs");
 const pipeline_1 = require("../../../../pipeline/src/index.js");
 exports.default = async (choice, options) => {
-  var _a;
   const config = await (0, getProjectConfig_1.getProjectConfig)();
   if (!config) {
     return;
@@ -19,5 +18,5 @@ exports.default = async (choice, options) => {
   if (options === null || options === void 0 ? void 0 : options.verbose) {
     (0, verboseBanner_1.printVerboseBanner)();
   }
-  await Promise.all([(0, pipeline_1.generatePipelineFiles)(context, (_a = config.pipelineType) !== null && _a !== void 0 ? _a : "gitlab"), (0, writeDotEnvFiles_1.writeDotEnvFiles)(context, choice), (0, writeEnvDTs_1.writeDTsFiles)(context, choice), (options === null || options === void 0 ? void 0 : options.printVariables) ? (0, printVariables_1.printVariables)(context, choice) : Promise.resolve()]);
+  await Promise.all([(0, pipeline_1.generatePipelineFiles)(context), (0, writeDotEnvFiles_1.writeDotEnvFiles)(context, choice), (0, writeEnvDTs_1.writeDTsFiles)(context, choice), (options === null || options === void 0 ? void 0 : options.printVariables) ? (0, printVariables_1.printVariables)(context, choice) : Promise.resolve()]);
 };

package/dist/cli/src/apps/catenv/catenv.js.map

@@ -1 +1 @@
-{"version":3,"file":"catenv.js","sourceRoot":"","sources":["../../../../../src/apps/catenv/catenv.ts"],"names":[],"mappings":";;AAAA,oEAAiE;AACjE,qDAAkD;AAElD,mDAAqD;AACrD,yDAAsD;AACtD,+CAA8C;AAC9C,kDAG6B;AAM7B,kBAAe,KAAK,EAAE,MAAe,EAAE,OAAiB,EAAE,EAAE;;IAC1D,MAAM,MAAM,GAAG,MAAM,IAAA,mCAAgB,GAAE,CAAC;IACxC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,8BAAmB,EAAC,MAAM,CAAC,CAAC;IAC5C,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE,CAAC;QACrB,IAAA,kCAAkB,GAAE,CAAC;IACvB,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,IAAA,gCAAqB,EAAC,OAAO,EAAE,MAAA,MAAM,CAAC,YAAY,mCAAI,QAAQ,CAAC;QAC/D,IAAA,mCAAgB,EAAC,OAAO,EAAE,MAAM,CAAC;QAEjC,IAAA,2BAAa,EAAC,OAAO,EAAE,MAAM,CAAC;QAC9B,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc;YACrB,CAAC,CAAC,IAAA,+BAAc,EAAC,OAAO,EAAE,MAAM,CAAC;YACjC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE;KACtB,CAAC,CAAC;AACL,CAAC,CAAC"}
+{"version":3,"file":"catenv.js","sourceRoot":"","sources":["../../../../../src/apps/catenv/catenv.ts"],"names":[],"mappings":";;AAAA,oEAAiE;AACjE,qDAAkD;AAElD,mDAAqD;AACrD,yDAAsD;AACtD,+CAA8C;AAC9C,kDAG6B;AAM7B,kBAAe,KAAK,EAAE,MAAe,EAAE,OAAiB,EAAE,EAAE;IAC1D,MAAM,MAAM,GAAG,MAAM,IAAA,mCAAgB,GAAE,CAAC;IACxC,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO;IACT,CAAC;IAED,MAAM,OAAO,GAAG,IAAA,8BAAmB,EAAC,MAAM,CAAC,CAAC;IAC5C,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,OAAO,EAAE,CAAC;QACrB,IAAA,kCAAkB,GAAE,CAAC;IACvB,CAAC;IAED,MAAM,OAAO,CAAC,GAAG,CAAC;QAChB,IAAA,gCAAqB,EAAC,OAAO,CAAC;QAC9B,IAAA,mCAAgB,EAAC,OAAO,EAAE,MAAM,CAAC;QAEjC,IAAA,2BAAa,EAAC,OAAO,EAAE,MAAM,CAAC;QAC9B,CAAA,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,cAAc;YACrB,CAAC,CAAC,IAAA,+BAAc,EAAC,OAAO,EAAE,MAAM,CAAC;YACjC,CAAC,CAAC,OAAO,CAAC,OAAO,EAAE;KACtB,CAAC,CAAC;AACL,CAAC,CAAC"}

package/dist/pipeline/src/backends/github/GithubBackend.d.ts

@@ -0,0 +1,12 @@
+import type { Config } from "../../types";
+import type { GithubWorkflow } from "../../types/github-types";
+import type { PipelineBackend, PipelineFile } from "../types";
+export declare class GithubBackend implements PipelineBackend {
+  readonly type: "github";
+  cleanup(): Promise<void>;
+  createFiles(config: Config): Promise<PipelineFile[]>;
+  /**
+   * all workflows keyed by file name, mainly for testing purposes
+   */
+  createWorkflows(config: Config): Promise<Record<string, GithubWorkflow>>;
+}

package/dist/pipeline/src/backends/github/GithubBackend.js

@@ -0,0 +1,170 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.GithubBackend = void 0;
+const promises_1 = require("fs/promises");
+const path_1 = require("path");
+const createAllJobs_1 = require("../../pipeline/createAllJobs");
+const config_1 = require("../../types/config");
+const ciVariables_1 = require("./ciVariables");
+const createGithubJobs_1 = require("./createGithubJobs");
+const githubReleaseJobs_1 = require("./githubReleaseJobs");
+const WORKFLOWS_FOLDER = ".github/workflows";
+/**
+ * generated workflow files are prefixed so that cleanup never touches
+ * user-maintained workflows in the same folder
+ */
+const GENERATED_FILE_PREFIX = "catladder-";
+const TRIGGER_WORKFLOWS = {
+  mr: {
+    name: "catladder review",
+    on: {
+      pull_request: {
+        types: ["opened", "synchronize", "reopened"]
+      }
+    },
+    concurrency: {
+      group: "catladder-review-${{ github.event.number }}",
+      "cancel-in-progress": true
+    }
+  },
+  mainBranch: {
+    name: "catladder main",
+    // TODO: make the default branch configurable
+    on: {
+      push: {
+        branches: ["main"]
+      }
+    }
+  },
+  taggedRelease: {
+    name: "catladder release",
+    on: {
+      push: {
+        tags: ["v*"]
+      }
+    }
+  }
+};
+class GithubBackend {
+  constructor() {
+    this.type = "github";
+  }
+  async cleanup() {
+    const entries = await (0, promises_1.readdir)(WORKFLOWS_FOLDER).catch(() => []);
+    await Promise.all(entries.filter(file => file.startsWith(GENERATED_FILE_PREFIX)).map(file => (0, promises_1.unlink)((0, path_1.join)(WORKFLOWS_FOLDER, file))));
+  }
+  async createFiles(config) {
+    const workflows = await this.createWorkflows(config);
+    return Object.entries(workflows).map(([fileName, workflow]) => ({
+      path: (0, path_1.join)(WORKFLOWS_FOLDER, fileName),
+      content: workflow
+    }));
+  }
+  /**
+   * all workflows keyed by file name, mainly for testing purposes
+   */
+  async createWorkflows(config) {
+    const workflows = {};
+    const reviewStopJobs = {};
+    const manualJobs = {};
+    for (const trigger of config_1.ALL_PIPELINE_TRIGGERS) {
+      const allJobs = await (0, createAllJobs_1.createAllJobs)({
+        config,
+        trigger,
+        pipelineType: this.type
+      });
+      const uploadProviderIds = (0, createGithubJobs_1.getUploadProviderIds)(allJobs);
+      const jobs = {};
+      // NOTE: agent jobs are gitlab-only and skipped on github
+      [...allJobs.workspaces, ...allJobs.components].forEach(({
+        context,
+        jobs: contextJobs
+      }) => contextJobs.forEach(job => {
+        const [id, githubJob] = (0, createGithubJobs_1.makeGithubJob)(context, job, allJobs, uploadProviderIds);
+        if (isReviewStopJob(context, job)) {
+          reviewStopJobs[id] = githubJob;
+        } else if (isManualTaskJob(job)) {
+          manualJobs[id] = githubJob;
+        } else {
+          jobs[id] = githubJob;
+        }
+      }));
+      if (trigger === "mainBranch") {
+        const releaseJobs = (0, githubReleaseJobs_1.getGithubReleaseJobs)(config, Object.keys(jobs));
+        Object.assign(jobs, releaseJobs.main);
+        Object.assign(manualJobs, releaseJobs.manual);
+      }
+      if (Object.keys(jobs).length > 0) {
+        workflows[`${GENERATED_FILE_PREFIX}${workflowFileName(trigger)}`] = {
+          ...TRIGGER_WORKFLOWS[trigger],
+          env: ciVariables_1.GITHUB_INJECTED_WORKFLOW_ENV,
+          jobs
+        };
+      }
+    }
+    if (Object.keys(reviewStopJobs).length > 0) {
+      workflows[`${GENERATED_FILE_PREFIX}review-stop.yml`] = {
+        name: "catladder review stop",
+        on: {
+          pull_request: {
+            types: ["closed"]
+          }
+        },
+        env: ciVariables_1.GITHUB_INJECTED_WORKFLOW_ENV,
+        jobs: reviewStopJobs
+      };
+    }
+    if (Object.keys(manualJobs).length > 0) {
+      workflows[`${GENERATED_FILE_PREFIX}manual.yml`] = {
+        name: "catladder manual tasks",
+        on: {
+          workflow_dispatch: {
+            inputs: {
+              job: {
+                description: "the task to run",
+                required: true,
+                type: "choice",
+                options: Object.keys(manualJobs)
+              }
+            }
+          }
+        },
+        env: ciVariables_1.GITHUB_INJECTED_WORKFLOW_ENV,
+        jobs: Object.fromEntries(Object.entries(manualJobs).map(([id, job]) => [id, {
+          ...job,
+          if: `\${{ inputs.job == '${id}' }}`
+        }]))
+      };
+    }
+    return workflows;
+  }
+}
+exports.GithubBackend = GithubBackend;
+const workflowFileName = trigger => {
+  switch (trigger) {
+    case "mr":
+      return "review.yml";
+    case "mainBranch":
+      return "main.yml";
+    case "taggedRelease":
+      return "release.yml";
+  }
+  throw new Error(`${trigger} is not supported`);
+};
+/**
+ * stop jobs of review environments run in their own workflow when the
+ * pull request is closed (the counterpart of gitlab's on_stop wiring)
+ */
+const isReviewStopJob = (context, job) => {
+  var _a;
+  return ((_a = job.environment) === null || _a === void 0 ? void 0 : _a.action) === "stop" && context.type === "component" && context.environment.envType === "review";
+};
+/**
+ * stop/rollback jobs of non-review environments have no automatic
+ * trigger; they are collected in a workflow_dispatch workflow
+ * (gitlab runs them as manual jobs inside the pipeline)
+ */
+const isManualTaskJob = job => job.stage === "stop" || job.stage === "rollback";

package/dist/pipeline/src/backends/github/GithubBackend.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"GithubBackend.js","sourceRoot":"","sources":["../../../../../../pipeline/src/backends/github/GithubBackend.ts"],"names":[],"mappings":";;;AAAA,0CAA8C;AAC9C,+BAA4B;AAC5B,gEAA6D;AAE7D,+CAA2D;AAI3D,+CAA6D;AAC7D,yDAAyE;AACzE,2DAA2D;AAE3D,MAAM,gBAAgB,GAAG,mBAAmB,CAAC;AAE7C;;;GAGG;AACH,MAAM,qBAAqB,GAAG,YAAY,CAAC;AAE3C,MAAM,iBAAiB,GAGnB;IACF,EAAE,EAAE;QACF,IAAI,EAAE,kBAAkB;QACxB,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,QAAQ,EAAE,aAAa,EAAE,UAAU,CAAC,EAAE,EAAE;QACtE,WAAW,EAAE;YACX,KAAK,EAAE,6CAA6C;YACpD,oBAAoB,EAAE,IAAI;SAC3B;KACF;IACD,UAAU,EAAE;QACV,IAAI,EAAE,gBAAgB;QACtB,6CAA6C;QAC7C,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,CAAC,MAAM,CAAC,EAAE,EAAE;KACrC;IACD,aAAa,EAAE;QACb,IAAI,EAAE,mBAAmB;QACzB,EAAE,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,IAAI,CAAC,EAAE,EAAE;KAC/B;CACF,CAAC;AAEF,MAAa,aAAa;IAA1B;QACW,SAAI,GAAG,QAAiB,CAAC;IAgHpC,CAAC;IA9GC,KAAK,CAAC,OAAO;QACX,MAAM,OAAO,GAAG,MAAM,IAAA,kBAAO,EAAC,gBAAgB,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;QAChE,MAAM,OAAO,CAAC,GAAG,CACf,OAAO;aACJ,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,qBAAqB,CAAC,CAAC;aACxD,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAA,iBAAM,EAAC,IAAA,WAAI,EAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC,CAAC,CACvD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CAAC,MAAc;QAC9B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,CAAC;QAErD,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,EAAE,CAAC,CAAC;YAC9D,IAAI,EAAE,IAAA,WAAI,EAAC,gBAAgB,EAAE,QAAQ,CAAC;YACtC,OAAO,EAAE,QAA8C;SACxD,CAAC,CAAC,CAAC;IACN,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,eAAe,CACnB,MAAc;QAEd,MAAM,SAAS,GAAmC,EAAE,CAAC;QAErD,MAAM,cAAc,GAA8B,EAAE,CAAC;QACrD,MAAM,UAAU,GAA8B,EAAE,CAAC;QAEjD,KAAK,MAAM,OAAO,IAAI,8BAAqB,EAAE,CAAC;YAC5C,MAAM,OAAO,GAAG,MAAM,IAAA,6BAAa,EAAC;gBAClC,MAAM;gBACN,OAAO;gBACP,YAAY,EAAE,IAAI,CAAC,IAAI;aACxB,CAAC,CAAC;YAEH,MAAM,iBAAiB,GAAG,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC;YACxD,MAAM,IAAI,GAA8B,EAAE,CAAC;YAE3C,yDAAyD;YACzD,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CACpD,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE,EAAE,CACjC,WAAW,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAC1B,MAAM,CAAC,EAAE,EAAE,SAAS,CAAC,GAAG,IAAA,gCAAa,EACnC,OAAO,EACP,GAAG,EACH,OAAO,EACP,iBAAiB,CAClB,CAAC;gBACF,IAAI,eAAe,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,CAAC;oBAClC,cAAc,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;gBACjC,CAAC;qBAAM,IAAI,eAAe,CAAC,GAAG,CAAC,EAAE,CAAC;oBAChC,UAAU,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;gBAC7B,CAAC;qBAAM,CAAC;oBACN,IAAI,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;gBACvB,CAAC;YACH,CAAC,CAAC,CACL,CAAC;YAEF,IAAI,OAAO,KAAK,YAAY,EAAE,CAAC;gBAC7B,MAAM,WAAW,GAAG,IAAA,wCAAoB,EAAC,MAAM,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;gBACpE,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;gBACtC,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,WAAW,CAAC,MAAM,CAAC,CAAC;YAChD,CAAC;YAED,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACjC,SAAS,CAAC,GAAG,qBAAqB,GAAG,gBAAgB,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG;oBAClE,GAAG,iBAAiB,CAAC,OAAO,CAAC;oBAC7B,GAAG,EAAE,0CAA4B;oBACjC,IAAI;iBACL,CAAC;YACJ,CAAC;QACH,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC3C,SAAS,CAAC,GAAG,qBAAqB,iBAAiB,CAAC,GAAG;gBACrD,IAAI,EAAE,uBAAuB;gBAC7B,EAAE,EAAE,EAAE,YAAY,EAAE,EAAE,KAAK,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE;gBAC3C,GAAG,EAAE,0CAA4B;gBACjC,IAAI,EAAE,cAAc;aACrB,CAAC;QACJ,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACvC,SAAS,CAAC,GAAG,qBAAqB,YAAY,CAAC,GAAG;gBAChD,IAAI,EAAE,wBAAwB;gBAC9B,EAAE,EAAE;oBACF,iBAAiB,EAAE;wBACjB,MAAM,EAAE;4BACN,GAAG,EAAE;gCACH,WAAW,EAAE,iBAAiB;gCAC9B,QAAQ,EAAE,IAAI;gCACd,IAAI,EAAE,QAAQ;gCACd,OAAO,EAAE,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;6BACjC;yBACF;qBACF;iBACF;gBACD,GAAG,EAAE,0CAA4B;gBACjC,IAAI,EAAE,MAAM,CAAC,WAAW,CACtB,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC;oBAC5C,EAAE;oBACF,EAAE,GAAG,GAAG,EAAE,EAAE,EAAE,uBAAuB,EAAE,MAAM,EAAE;iBAChD,CAAC,CACH;aACF,CAAC;QACJ,CAAC;QAED,OAAO,SAAS,CAAC;IACnB,CAAC;CACF;AAjHD,sCAiHC;AAED,MAAM,gBAAgB,GAAG,CAAC,OAAwB,EAAU,EAAE;IAC5D,QAAQ,OAAO,EAAE,CAAC;QAChB,KAAK,IAAI;YACP,OAAO,YAAY,CAAC;QACtB,KAAK,YAAY;YACf,OAAO,UAAU,CAAC;QACpB,KAAK,eAAe;YAClB,OAAO,aAAa,CAAC;IACzB,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,GAAG,OAAO,mBAAmB,CAAC,CAAC;AACjD,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,eAAe,GAAG,CAAC,OAAgB,EAAE,GAAiB,EAAE,EAAE;;IAC9D,OAAA,CAAA,MAAA,GAAG,CAAC,WAAW,0CAAE,MAAM,MAAK,MAAM;QAClC,OAAO,CAAC,IAAI,KAAK,WAAW;QAC5B,OAAO,CAAC,WAAW,CAAC,OAAO,KAAK,QAAQ,CAAA;CAAA,CAAC;AAE3C;;;;GAIG;AACH,MAAM,eAAe,GAAG,CAAC,GAAiB,EAAE,EAAE,CAC5C,GAAG,CAAC,KAAK,KAAK,MAAM,IAAI,GAAG,CAAC,KAAK,KAAK,UAAU,CAAC"}

package/dist/pipeline/src/backends/github/ciVariables.d.ts

@@ -0,0 +1,14 @@
+import type { CiVariableName } from "../../bash/ciVariables";
+/**
+ * how the github backend names the predefined CI variables.
+ *
+ * GITHUB_* variables are provided by github actions natively; the CL_*
+ * variables are injected by the {@link GithubBackend} itself (workflow or
+ * job level), because github has no direct counterpart.
+ */
+export declare const GITHUB_CI_VARIABLES: Record<CiVariableName, string>;
+/**
+ * the workflow-level env the backend injects to provide the CL_*
+ * variables referenced by {@link GITHUB_CI_VARIABLES}
+ */
+export declare const GITHUB_INJECTED_WORKFLOW_ENV: Record<string, string>;

package/dist/pipeline/src/backends/github/ciVariables.js

@@ -0,0 +1,31 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.GITHUB_INJECTED_WORKFLOW_ENV = exports.GITHUB_CI_VARIABLES = void 0;
+/**
+ * how the github backend names the predefined CI variables.
+ *
+ * GITHUB_* variables are provided by github actions natively; the CL_*
+ * variables are injected by the {@link GithubBackend} itself (workflow or
+ * job level), because github has no direct counterpart.
+ */
+exports.GITHUB_CI_VARIABLES = {
+  commitSha: "GITHUB_SHA",
+  jobToken: "CL_JOB_TOKEN",
+  jobImage: "CL_JOB_IMAGE",
+  registry: "CL_REGISTRY",
+  registryImage: "CL_REGISTRY_IMAGE"
+};
+/**
+ * the workflow-level env the backend injects to provide the CL_*
+ * variables referenced by {@link GITHUB_CI_VARIABLES}
+ */
+exports.GITHUB_INJECTED_WORKFLOW_ENV = {
+  CL_JOB_TOKEN: "${{ github.token }}",
+  CL_REGISTRY: "ghcr.io",
+  CL_REGISTRY_IMAGE: "ghcr.io/${{ github.repository }}",
+  // empty outside of pull request events
+  CL_PR_NUMBER: "${{ github.event.number }}"
+};

package/dist/pipeline/src/backends/github/ciVariables.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ciVariables.js","sourceRoot":"","sources":["../../../../../../pipeline/src/backends/github/ciVariables.ts"],"names":[],"mappings":";;;AAEA;;;;;;GAMG;AACU,QAAA,mBAAmB,GAAmC;IACjE,SAAS,EAAE,YAAY;IACvB,QAAQ,EAAE,cAAc;IACxB,QAAQ,EAAE,cAAc;IACxB,QAAQ,EAAE,aAAa;IACvB,aAAa,EAAE,mBAAmB;CACnC,CAAC;AAEF;;;GAGG;AACU,QAAA,4BAA4B,GAA2B;IAClE,YAAY,EAAE,qBAAqB;IACnC,WAAW,EAAE,SAAS;IACtB,iBAAiB,EAAE,kCAAkC;IACrD,uCAAuC;IACvC,YAAY,EAAE,4BAA4B;CAC3C,CAAC"}

package/dist/pipeline/src/backends/github/createGithubJobs.d.ts

@@ -0,0 +1,17 @@
+import type { AllCatladderJobs } from "../../pipeline/createAllJobs";
+import type { Context } from "../../types";
+import type { GithubJob } from "../../types/github-types";
+import type { CatladderJob } from "../../types/jobs";
+export declare const githubJobId: (context: Context, jobName: string) => string;
+type ResolvedNeed = {
+  id: string;
+  artifacts: boolean;
+};
+export declare const resolveGithubNeeds: (context: Context, job: CatladderJob, allJobs: AllCatladderJobs) => ResolvedNeed[];
+export declare const makeGithubJob: (context: Context, job: CatladderJob, allJobs: AllCatladderJobs, uploadProviderIds: Set<string>) => [id: string, githubJob: GithubJob];
+/**
+ * the ids of all jobs whose artifacts are consumed by other jobs
+ * (they need an upload step)
+ */
+export declare const getUploadProviderIds: (allJobs: AllCatladderJobs) => Set<string>;
+export {};

package/dist/pipeline/src/backends/github/createGithubJobs.js

@@ -0,0 +1,208 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getUploadProviderIds = exports.makeGithubJob = exports.resolveGithubNeeds = exports.githubJobId = void 0;
+const lodash_es_1 = require("lodash-es");
+const getInjectVarsScript_1 = require("../../bash/getInjectVarsScript");
+const createJobCache_1 = require("../../build/cache/createJobCache");
+const getEnvironmentVariables_1 = require("../../context/getEnvironmentVariables");
+const utils_1 = require("../../utils");
+const gitlab_1 = require("../../utils/gitlab");
+const scriptFunctions_1 = require("./scriptFunctions");
+/**
+ * runner variables that only make sense on gitlab runners and must not
+ * leak into github jobs (docker-in-docker daemon config, kubernetes
+ * executor resource requests, gitlab clone strategy)
+ */
+const GITLAB_ONLY_RUNNER_VARIABLES = new Set(["DOCKER_HOST", "DOCKER_TLS_CERTDIR", "DOCKER_DRIVER", "KUBERNETES_CPU_REQUEST", "KUBERNETES_MEMORY_REQUEST", "KUBERNETES_CPU_LIMIT", "KUBERNETES_MEMORY_LIMIT", "GIT_STRATEGY"]);
+/**
+ * github runs docker natively on its runners, gitlab needs a
+ * docker-in-docker service for it
+ */
+const isDindService = image => /(^|\/)docker:.*dind/.test(image);
+const slug = value => {
+  const slugged = value.toLowerCase().replace(/[^a-z0-9]+/g, "-").replace(/^-+|-+$/g, "");
+  // job ids must start with a letter or _
+  return /^[a-z_]/.test(slugged) ? slugged : `job-${slugged}`;
+};
+const githubJobId = (context, jobName) => slug(`${context.type === "workspace" ? "ws-" : ""}${context.name}-${jobName}-${context.env}`);
+exports.githubJobId = githubJobId;
+const githubJobName = (context, jobName) => `${context.name} ${jobName} | ${context.env}`;
+const resolveNeed = (context, need, allJobs) => {
+  var _a;
+  const env = context.env;
+  const findComponentJob = (componentName, jobName) => {
+    const provider = allJobs.components.find(c => c.context.name === componentName && c.context.env === env);
+    const job = provider === null || provider === void 0 ? void 0 : provider.jobs.find(j => j.name === jobName);
+    if (!provider || !job) {
+      throw new Error(`unknown job referenced: '${jobName}' from '${env}:${componentName}'`);
+    }
+    return (0, exports.githubJobId)(provider.context, jobName);
+  };
+  const findWorkspaceJob = (workspaceName, jobName) => {
+    const provider = allJobs.workspaces.find(w => w.context.name === workspaceName && w.context.env === env);
+    const job = provider === null || provider === void 0 ? void 0 : provider.jobs.find(j => j.name === jobName);
+    if (!provider || !job) {
+      throw new Error(`unknown job referenced: '${jobName}' from workspace '${env}:${workspaceName}'`);
+    }
+    return (0, exports.githubJobId)(provider.context, jobName);
+  };
+  if ((0, lodash_es_1.isObject)(need)) {
+    if ("workspaceName" in need && need.workspaceName) {
+      return {
+        id: findWorkspaceJob(need.workspaceName, need.job),
+        artifacts: need.artifacts
+      };
+    }
+    return {
+      id: findComponentJob((_a = "componentName" in need ? need.componentName : undefined) !== null && _a !== void 0 ? _a : context.name, need.job),
+      artifacts: need.artifacts
+    };
+  }
+  return {
+    id: context.type === "workspace" ? findWorkspaceJob(context.name, need) : findComponentJob(context.name, need),
+    // plain string needs download artifacts by default (gitlab semantics)
+    artifacts: true
+  };
+};
+const resolveGithubNeeds = (context, job, allJobs) => {
+  var _a;
+  const resolved = ((_a = job.needs) !== null && _a !== void 0 ? _a : []).map(need => resolveNeed(context, need, allJobs));
+  // deduplicate by provider id, explicit entries win (they come last)
+  return [...new Map(resolved.map(n => [n.id, n])).values()].sort((a, b) => a.id.localeCompare(b.id));
+};
+exports.resolveGithubNeeds = resolveGithubNeeds;
+const createCacheSteps = (context, job) => {
+  var _a, _b;
+  if (!((_a = job.caches) === null || _a === void 0 ? void 0 : _a.length)) {
+    return [];
+  }
+  const lowered = (_b = (0, createJobCache_1.createJobCacheFromCacheConfigs)(context, job.caches)) !== null && _b !== void 0 ? _b : [];
+  return (0, utils_1.ensureArray)(lowered).map(cache => {
+    var _a, _b, _c, _d, _e, _f;
+    const paths = (0, utils_1.ensureArray)((_a = cache.paths) !== null && _a !== void 0 ? _a : []);
+    const key = cache.key;
+    const {
+      cacheKey,
+      restoreKeyPrefix,
+      label
+    } = typeof key === "string" || key === undefined ? {
+      // unique key per run so the cache is re-saved, restored via prefix
+      cacheKey: `${key !== null && key !== void 0 ? key : "cache"}-\${{ github.run_id }}`,
+      restoreKeyPrefix: `${key !== null && key !== void 0 ? key : "cache"}-`,
+      label: key !== null && key !== void 0 ? key : "cache"
+    } : {
+      cacheKey: `${(_b = key.prefix) !== null && _b !== void 0 ? _b : "files"}-\${{ hashFiles(${((_c = key.files) !== null && _c !== void 0 ? _c : []).map(f => `'${f}'`).join(", ")}) }}`,
+      restoreKeyPrefix: `${(_d = key.prefix) !== null && _d !== void 0 ? _d : "files"}-`,
+      label: (_e = key.prefix) !== null && _e !== void 0 ? _e : ((_f = key.files) !== null && _f !== void 0 ? _f : []).join(",")
+    };
+    return {
+      name: `Cache ${label}`,
+      // pull-only caches are restored but never saved
+      uses: cache.policy === "pull" ? "actions/cache/restore@v4" : "actions/cache@v4",
+      with: {
+        path: paths.join("\n"),
+        key: cacheKey,
+        "restore-keys": restoreKeyPrefix
+      }
+    };
+  });
+};
+const getSecretsEnv = context => {
+  var _a, _b;
+  const keys = [...context.environment.secretEnvVarKeys, ...((_a = context.environment.jobOnlyVars.build.secretEnvVarKeys) !== null && _a !== void 0 ? _a : []), ...((_b = context.environment.jobOnlyVars.deploy.secretEnvVarKeys) !== null && _b !== void 0 ? _b : [])];
+  return Object.fromEntries(keys.map(({
+    key
+  }) => {
+    const name = (0, getEnvironmentVariables_1.getSecretVarName)(context.env, context.name, key);
+    return [name, `\${{ secrets.${name} }}`];
+  }));
+};
+const makeGithubJob = (context, job, allJobs, uploadProviderIds) => {
+  var _a, _b, _c, _d, _e, _f, _g, _h, _j;
+  const id = (0, exports.githubJobId)(context, job.name);
+  const isComponent = context.type === "component";
+  const createsJobEnv = !!job.environment && isComponent && (!job.environment.action || job.environment.action === "start");
+  const skipCheckout = ((_a = job.runnerVariables) === null || _a === void 0 ? void 0 : _a.GIT_STRATEGY) === "none";
+  const needs = (0, exports.resolveGithubNeeds)(context, job, allJobs);
+  const image = typeof job.image === "string" ? job.image : Array.isArray(job.image) ? job.image[0] : (_b = job.image) === null || _b === void 0 ? void 0 : _b.name;
+  const runScript = [...(0, scriptFunctions_1.getGithubScriptFunctionDefinitions)(), ...(0, gitlab_1.collapseableSection)("injectvars", "Injecting variables")((0, getInjectVarsScript_1.getInjectVarsScript)((_c = job.variables) !== null && _c !== void 0 ? _c : {})), ...((_e = (_d = job.script) === null || _d === void 0 ? void 0 : _d.filter(utils_1.notNil)) !== null && _e !== void 0 ? _e : []), ...(createsJobEnv ? [`echo "url=$ROOT_URL" >> "$GITHUB_OUTPUT"`] : [])].join("\n");
+  const artifactPaths = (_g = (_f = job.artifacts) === null || _f === void 0 ? void 0 : _f.paths) !== null && _g !== void 0 ? _g : [];
+  const services = Object.fromEntries(((_h = job.services) !== null && _h !== void 0 ? _h : []).map(service => typeof service === "string" ? {
+    name: service
+  } : service).filter(service => !isDindService(service.name)).map(service => [slug("alias" in service && service.alias ? service.alias : service.name), {
+    image: service.name,
+    ...("variables" in service && service.variables ? {
+      env: service.variables
+    } : {})
+  }]));
+  const env = {
+    ...Object.fromEntries(Object.entries((_j = job.runnerVariables) !== null && _j !== void 0 ? _j : {}).filter(([key]) => !GITLAB_ONLY_RUNNER_VARIABLES.has(key))),
+    ...(isComponent ? getSecretsEnv(context) : {}),
+    CL_JOB_IMAGE: image !== null && image !== void 0 ? image : "runner"
+  };
+  const githubJob = {
+    name: githubJobName(context, job.name),
+    "runs-on": "ubuntu-latest",
+    ...(needs.length > 0 ? {
+      needs: needs.map(n => n.id)
+    } : {}),
+    ...(image ? {
+      container: {
+        image
+      }
+    } : {}),
+    ...(Object.keys(services).length > 0 ? {
+      services
+    } : {}),
+    ...(job.environment && isComponent ? {
+      environment: {
+        name: context.environment.envType === "review" ? `review-pr\${{ github.event.number }}-${context.name}` : `${context.env}-${context.name}`,
+        ...(createsJobEnv ? {
+          url: "${{ steps.main.outputs.url }}"
+        } : {})
+      }
+    } : {}),
+    env,
+    steps: [...(skipCheckout ? [] : [{
+      name: "Checkout",
+      uses: "actions/checkout@v4"
+    }]), ...createCacheSteps(context, job), ...needs.filter(n => n.artifacts).map(n => ({
+      name: `Download artifacts from ${n.id}`,
+      uses: "actions/download-artifact@v4",
+      with: {
+        name: n.id
+      }
+    })), {
+      name: job.name,
+      id: "main",
+      run: runScript,
+      shell: "bash"
+    }, ...(uploadProviderIds.has(id) || artifactPaths.length > 0 ? artifactPaths.length > 0 ? [{
+      name: "Upload artifacts",
+      uses: "actions/upload-artifact@v4",
+      with: {
+        name: id,
+        path: artifactPaths.join("\n"),
+        "if-no-files-found": "warn"
+      }
+    }] : [] : [])]
+  };
+  return [id, githubJob];
+};
+exports.makeGithubJob = makeGithubJob;
+/**
+ * the ids of all jobs whose artifacts are consumed by other jobs
+ * (they need an upload step)
+ */
+const getUploadProviderIds = allJobs => {
+  const ids = new Set();
+  [...allJobs.workspaces, ...allJobs.components].forEach(({
+    context,
+    jobs
+  }) => jobs.forEach(job => (0, exports.resolveGithubNeeds)(context, job, allJobs).filter(n => n.artifacts).forEach(n => ids.add(n.id))));
+  return ids;
+};
+exports.getUploadProviderIds = getUploadProviderIds;

package/dist/pipeline/src/backends/github/createGithubJobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createGithubJobs.js","sourceRoot":"","sources":["../../../../../../pipeline/src/backends/github/createGithubJobs.ts"],"names":[],"mappings":";;;AAAA,yCAAqC;AACrC,wEAAqE;AACrE,qEAAkF;AAClF,mFAAyE;AASzE,uCAAkD;AAClD,+CAAyD;AACzD,uDAAuE;AAEvE;;;;GAIG;AACH,MAAM,4BAA4B,GAAG,IAAI,GAAG,CAAC;IAC3C,aAAa;IACb,oBAAoB;IACpB,eAAe;IACf,wBAAwB;IACxB,2BAA2B;IAC3B,sBAAsB;IACtB,yBAAyB;IACzB,cAAc;CACf,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,aAAa,GAAG,CAAC,KAAa,EAAE,EAAE,CAAC,qBAAqB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;AAE3E,MAAM,IAAI,GAAG,CAAC,KAAa,EAAE,EAAE;IAC7B,MAAM,OAAO,GAAG,KAAK;SAClB,WAAW,EAAE;SACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;SAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;IAC3B,wCAAwC;IACxC,OAAO,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,OAAO,EAAE,CAAC;AAC9D,CAAC,CAAC;AAEK,MAAM,WAAW,GAAG,CAAC,OAAgB,EAAE,OAAe,EAAE,EAAE,CAC/D,IAAI,CACF,GAAG,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,IAAI,OAAO,CAAC,GAAG,EAAE,CACxF,CAAC;AAHS,QAAA,WAAW,eAGpB;AAEJ,MAAM,aAAa,GAAG,CAAC,OAAgB,EAAE,OAAe,EAAE,EAAE,CAC1D,GAAG,OAAO,CAAC,IAAI,IAAI,OAAO,MAAM,OAAO,CAAC,GAAG,EAAE,CAAC;AAIhD,MAAM,WAAW,GAAG,CAClB,OAAgB,EAChB,IAAsB,EACtB,OAAyB,EACX,EAAE;;IAChB,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAExB,MAAM,gBAAgB,GAAG,CAAC,aAAqB,EAAE,OAAe,EAAE,EAAE;QAClE,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CACtC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,aAAa,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,KAAK,GAAG,CACjE,CAAC;QACF,MAAM,GAAG,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;QAC3D,IAAI,CAAC,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CACb,4BAA4B,OAAO,WAAW,GAAG,IAAI,aAAa,GAAG,CACtE,CAAC;QACJ,CAAC;QACD,OAAO,IAAA,mBAAW,EAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,CAAC,aAAqB,EAAE,OAAe,EAAE,EAAE;QAClE,MAAM,QAAQ,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CACtC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,KAAK,aAAa,IAAI,CAAC,CAAC,OAAO,CAAC,GAAG,KAAK,GAAG,CACjE,CAAC;QACF,MAAM,GAAG,GAAG,QAAQ,aAAR,QAAQ,uBAAR,QAAQ,CAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC;QAC3D,IAAI,CAAC,QAAQ,IAAI,CAAC,GAAG,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CACb,4BAA4B,OAAO,qBAAqB,GAAG,IAAI,aAAa,GAAG,CAChF,CAAC;QACJ,CAAC;QACD,OAAO,IAAA,mBAAW,EAAC,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC,CAAC;IAEF,IAAI,IAAA,oBAAQ,EAAC,IAAI,CAAC,EAAE,CAAC;QACnB,IAAI,eAAe,IAAI,IAAI,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YAClD,OAAO;gBACL,EAAE,EAAE,gBAAgB,CAAC,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,GAAG,CAAC;gBAClD,SAAS,EAAE,IAAI,CAAC,SAAS;aAC1B,CAAC;QACJ,CAAC;QACD,OAAO;YACL,EAAE,EAAE,gBAAgB,CAClB,MAAA,CAAC,eAAe,IAAI,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS,CAAC,mCACxD,OAAO,CAAC,IAAI,EACd,IAAI,CAAC,GAAG,CACT;YACD,SAAS,EAAE,IAAI,CAAC,SAAS;SAC1B,CAAC;IACJ,CAAC;IACD,OAAO;QACL,EAAE,EACA,OAAO,CAAC,IAAI,KAAK,WAAW;YAC1B,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC;YACtC,CAAC,CAAC,gBAAgB,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC;QAC1C,sEAAsE;QACtE,SAAS,EAAE,IAAI;KAChB,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,kBAAkB,GAAG,CAChC,OAAgB,EAChB,GAAiB,EACjB,OAAyB,EACT,EAAE;;IAClB,MAAM,QAAQ,GAAG,CAAC,MAAA,GAAG,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAC9C,WAAW,CAAC,OAAO,EAAE,IAAI,EAAE,OAAO,CAAC,CACpC,CAAC;IACF,oEAAoE;IACpE,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CACzE,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,CAAC,CACzB,CAAC;AACJ,CAAC,CAAC;AAZW,QAAA,kBAAkB,sBAY7B;AAEF,MAAM,gBAAgB,GAAG,CACvB,OAAgB,EAChB,GAAiB,EACH,EAAE;;IAChB,IAAI,CAAC,CAAA,MAAA,GAAG,CAAC,MAAM,0CAAE,MAAM,CAAA,EAAE,CAAC;QACxB,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,OAAO,GAAG,MAAA,IAAA,+CAA8B,EAAC,OAAO,EAAE,GAAG,CAAC,MAAM,CAAC,mCAAI,EAAE,CAAC;IAC1E,OAAO,IAAA,mBAAW,EAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;;QACxC,MAAM,KAAK,GAAG,IAAA,mBAAW,EAAC,MAAA,KAAK,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC;QAC7C,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC;QACtB,MAAM,EAAE,QAAQ,EAAE,gBAAgB,EAAE,KAAK,EAAE,GACzC,OAAO,GAAG,KAAK,QAAQ,IAAI,GAAG,KAAK,SAAS;YAC1C,CAAC,CAAC;gBACE,mEAAmE;gBACnE,QAAQ,EAAE,GAAG,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,OAAO,wBAAwB;gBACnD,gBAAgB,EAAE,GAAG,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,OAAO,GAAG;gBACtC,KAAK,EAAE,GAAG,aAAH,GAAG,cAAH,GAAG,GAAI,OAAO;aACtB;YACH,CAAC,CAAC;gBACE,QAAQ,EAAE,GAAG,MAAA,GAAG,CAAC,MAAM,mCAAI,OAAO,mBAAmB,CACnD,MAAA,GAAG,CAAC,KAAK,mCAAI,EAAE,CAChB;qBACE,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC;qBACpB,IAAI,CAAC,IAAI,CAAC,MAAM;gBACnB,gBAAgB,EAAE,GAAG,MAAA,GAAG,CAAC,MAAM,mCAAI,OAAO,GAAG;gBAC7C,KAAK,EAAE,MAAA,GAAG,CAAC,MAAM,mCAAI,CAAC,MAAA,GAAG,CAAC,KAAK,mCAAI,EAAE,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC;aACjD,CAAC;QACR,OAAO;YACL,IAAI,EAAE,SAAS,KAAK,EAAE;YACtB,gDAAgD;YAChD,IAAI,EACF,KAAK,CAAC,MAAM,KAAK,MAAM;gBACrB,CAAC,CAAC,0BAA0B;gBAC5B,CAAC,CAAC,kBAAkB;YACxB,IAAI,EAAE;gBACJ,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC;gBACtB,GAAG,EAAE,QAAQ;gBACb,cAAc,EAAE,gBAAgB;aACjC;SACF,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AAEF,MAAM,aAAa,GAAG,CAAC,OAAyB,EAA0B,EAAE;;IAC1E,MAAM,IAAI,GAAG;QACX,GAAG,OAAO,CAAC,WAAW,CAAC,gBAAgB;QACvC,GAAG,CAAC,MAAA,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,gBAAgB,mCAAI,EAAE,CAAC;QACjE,GAAG,CAAC,MAAA,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC,gBAAgB,mCAAI,EAAE,CAAC;KACnE,CAAC;IACF,OAAO,MAAM,CAAC,WAAW,CACvB,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,EAAE;QACnB,MAAM,IAAI,GAAG,IAAA,0CAAgB,EAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;QAC9D,OAAO,CAAC,IAAI,EAAE,gBAAgB,IAAI,KAAK,CAAC,CAAC;IAC3C,CAAC,CAAC,CACH,CAAC;AACJ,CAAC,CAAC;AAEK,MAAM,aAAa,GAAG,CAC3B,OAAgB,EAChB,GAAiB,EACjB,OAAyB,EACzB,iBAA8B,EACM,EAAE;;IACtC,MAAM,EAAE,GAAG,IAAA,mBAAW,EAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC;IAC1C,MAAM,WAAW,GAAG,OAAO,CAAC,IAAI,KAAK,WAAW,CAAC;IAEjD,MAAM,aAAa,GACjB,CAAC,CAAC,GAAG,CAAC,WAAW;QACjB,WAAW;QACX,CAAC,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,IAAI,GAAG,CAAC,WAAW,CAAC,MAAM,KAAK,OAAO,CAAC,CAAC;IAElE,MAAM,YAAY,GAAG,CAAA,MAAA,GAAG,CAAC,eAAe,0CAAE,YAAY,MAAK,MAAM,CAAC;IAElE,MAAM,KAAK,GAAG,IAAA,0BAAkB,EAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAExD,MAAM,KAAK,GACT,OAAO,GAAG,CAAC,KAAK,KAAK,QAAQ;QAC3B,CAAC,CAAC,GAAG,CAAC,KAAK;QACX,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC;YACxB,CAAC,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC;YACd,CAAC,CAAC,MAAA,GAAG,CAAC,KAAK,0CAAE,IAAI,CAAC;IAExB,MAAM,SAAS,GAAG;QAChB,GAAG,IAAA,oDAAkC,GAAE;QACvC,GAAG,IAAA,4BAAmB,EACpB,YAAY,EACZ,qBAAqB,CACtB,CAAC,IAAA,yCAAmB,EAAC,MAAA,GAAG,CAAC,SAAS,mCAAI,EAAE,CAAC,CAAC;QAC3C,GAAG,CAAC,MAAA,MAAA,GAAG,CAAC,MAAM,0CAAE,MAAM,CAAC,cAAM,CAAC,mCAAI,EAAE,CAAC;QACrC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;KACvE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAEb,MAAM,aAAa,GAAG,MAAA,MAAA,GAAG,CAAC,SAAS,0CAAE,KAAK,mCAAI,EAAE,CAAC;IAEjD,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CACjC,CAAC,MAAA,GAAG,CAAC,QAAQ,mCAAI,EAAE,CAAC;SACjB,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACf,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC,OAAO,CAC1D;SACA,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;SACjD,GAAG,CAAC,CAAC,OAAO,EAA2B,EAAE,CAAC;QACzC,IAAI,CACF,OAAO,IAAI,OAAO,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,CACnE;QACD;YACE,KAAK,EAAE,OAAO,CAAC,IAAI;YACnB,GAAG,CAAC,WAAW,IAAI,OAAO,IAAI,OAAO,CAAC,SAAS;gBAC7C,CAAC,CAAC,EAAE,GAAG,EAAE,OAAO,CAAC,SAAmC,EAAE;gBACtD,CAAC,CAAC,EAAE,CAAC;SACR;KACF,CAAC,CACL,CAAC;IAEF,MAAM,GAAG,GAAG;QACV,GAAG,MAAM,CAAC,WAAW,CACnB,MAAM,CAAC,OAAO,CAAC,MAAA,GAAG,CAAC,eAAe,mCAAI,EAAE,CAAC,CAAC,MAAM,CAC9C,CAAC,CAAC,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,4BAA4B,CAAC,GAAG,CAAC,GAAG,CAAC,CAClD,CACF;QACD,GAAG,CAAC,WAAW,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9C,YAAY,EAAE,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,QAAQ;KAChC,CAAC;IAEF,MAAM,SAAS,GAAc;QAC3B,IAAI,EAAE,aAAa,CAAC,OAAO,EAAE,GAAG,CAAC,IAAI,CAAC;QACtC,SAAS,EAAE,eAAe;QAC1B,GAAG,CAAC,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC9D,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAC1C,GAAG,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACzD,GAAG,CAAC,GAAG,CAAC,WAAW,IAAI,WAAW;YAChC,CAAC,CAAC;gBACE,WAAW,EAAE;oBACX,IAAI,EACF,OAAO,CAAC,WAAW,CAAC,OAAO,KAAK,QAAQ;wBACtC,CAAC,CAAC,wCAAwC,OAAO,CAAC,IAAI,EAAE;wBACxD,CAAC,CAAC,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,IAAI,EAAE;oBACtC,GAAG,CAAC,aAAa,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,+BAA+B,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;iBACnE;aACF;YACH,CAAC,CAAC,EAAE,CAAC;QACP,GAAG;QACH,KAAK,EAAE;YACL,GAAG,CAAC,YAAY;gBACd,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,IAAI,EAAE,qBAAqB,EAAE,CAAC,CAAC;YACxD,GAAG,gBAAgB,CAAC,OAAO,EAAE,GAAG,CAAC;YACjC,GAAG,KAAK;iBACL,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;iBAC1B,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;gBACX,IAAI,EAAE,2BAA2B,CAAC,CAAC,EAAE,EAAE;gBACvC,IAAI,EAAE,8BAA8B;gBACpC,IAAI,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,EAAE;aACrB,CAAC,CAAC;YACL;gBACE,IAAI,EAAE,GAAG,CAAC,IAAI;gBACd,EAAE,EAAE,MAAM;gBACV,GAAG,EAAE,SAAS;gBACd,KAAK,EAAE,MAAM;aACd;YACD,GAAG,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC;gBACvD,CAAC,CAAC,aAAa,CAAC,MAAM,GAAG,CAAC;oBACxB,CAAC,CAAC;wBACE;4BACE,IAAI,EAAE,kBAAkB;4BACxB,IAAI,EAAE,4BAA4B;4BAClC,IAAI,EAAE;gCACJ,IAAI,EAAE,EAAE;gCACR,IAAI,EAAE,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC;gCAC9B,mBAAmB,EAAE,MAAM;6BAC5B;yBACF;qBACF;oBACH,CAAC,CAAC,EAAE;gBACN,CAAC,CAAC,EAAE,CAAC;SACR;KACF,CAAC;IAEF,OAAO,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;AACzB,CAAC,CAAC;AAzHW,QAAA,aAAa,iBAyHxB;AAEF;;;GAGG;AACI,MAAM,oBAAoB,GAAG,CAClC,OAAyB,EACZ,EAAE;IACf,MAAM,GAAG,GAAG,IAAI,GAAG,EAAU,CAAC;IAC9B,CAAC,GAAG,OAAO,CAAC,UAAU,EAAE,GAAG,OAAO,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,EAAE,EAAE,CAC3E,IAAI,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE,CACnB,IAAA,0BAAkB,EAAC,OAAO,EAAE,GAAG,EAAE,OAAO,CAAC;SACtC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;SAC1B,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CACjC,CACF,CAAC;IACF,OAAO,GAAG,CAAC;AACb,CAAC,CAAC;AAZW,QAAA,oBAAoB,wBAY/B"}

package/dist/pipeline/src/backends/github/githubReleaseJobs.d.ts

@@ -0,0 +1,15 @@
+import type { Config } from "../../types";
+import type { GithubJob } from "../../types/github-types";
+/**
+ * the release jobs for the github backend (the counterpart of the
+ * gitlab release jobs):
+ * - releases.when === "auto": the release job runs in the main-branch
+ *   workflow after all other jobs; a force variant goes to the manual
+ *   tasks workflow
+ * - otherwise (manual, the default): the release job goes to the
+ *   manual tasks workflow
+ */
+export declare const getGithubReleaseJobs: (config: Config, mainWorkflowJobIds: string[]) => {
+  main: Record<string, GithubJob>;
+  manual: Record<string, GithubJob>;
+};

package/dist/pipeline/src/backends/github/githubReleaseJobs.js

@@ -0,0 +1,65 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getGithubReleaseJobs = void 0;
+const runner_1 = require("../../runner");
+const createReleaseJob = needs => ({
+  name: "create release",
+  "runs-on": "ubuntu-latest",
+  container: {
+    image: (0, runner_1.getRunnerImage)("semantic-release")
+  },
+  // semantic-release pushes the version tag and release commit
+  permissions: {
+    contents: "write"
+  },
+  ...(needs && needs.length > 0 ? {
+    needs
+  } : {}),
+  env: {
+    GITHUB_TOKEN: "${{ github.token }}"
+  },
+  steps: [{
+    name: "Checkout",
+    uses: "actions/checkout@v4",
+    // semantic-release needs the full history to determine the version
+    with: {
+      "fetch-depth": 0
+    }
+  }, {
+    name: "create release",
+    run: "semanticRelease",
+    shell: "bash"
+  }]
+});
+/**
+ * the release jobs for the github backend (the counterpart of the
+ * gitlab release jobs):
+ * - releases.when === "auto": the release job runs in the main-branch
+ *   workflow after all other jobs; a force variant goes to the manual
+ *   tasks workflow
+ * - otherwise (manual, the default): the release job goes to the
+ *   manual tasks workflow
+ */
+const getGithubReleaseJobs = (config, mainWorkflowJobIds) => {
+  var _a;
+  if (((_a = config.releases) === null || _a === void 0 ? void 0 : _a.when) === "auto") {
+    return {
+      main: {
+        "create-release": createReleaseJob(mainWorkflowJobIds)
+      },
+      manual: {
+        "force-create-release": createReleaseJob()
+      }
+    };
+  }
+  return {
+    main: {},
+    manual: {
+      "create-release": createReleaseJob()
+    }
+  };
+};
+exports.getGithubReleaseJobs = getGithubReleaseJobs;

package/dist/pipeline/src/backends/github/githubReleaseJobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"githubReleaseJobs.js","sourceRoot":"","sources":["../../../../../../pipeline/src/backends/github/githubReleaseJobs.ts"],"names":[],"mappings":";;;AAAA,yCAA8C;AAI9C,MAAM,gBAAgB,GAAG,CAAC,KAAgB,EAAa,EAAE,CAAC,CAAC;IACzD,IAAI,EAAE,gBAAgB;IACtB,SAAS,EAAE,eAAe;IAC1B,SAAS,EAAE,EAAE,KAAK,EAAE,IAAA,uBAAc,EAAC,kBAAkB,CAAC,EAAE;IACxD,6DAA6D;IAC7D,WAAW,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE;IAClC,GAAG,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC/C,GAAG,EAAE;QACH,YAAY,EAAE,qBAAqB;KACpC;IACD,KAAK,EAAE;QACL;YACE,IAAI,EAAE,UAAU;YAChB,IAAI,EAAE,qBAAqB;YAC3B,mEAAmE;YACnE,IAAI,EAAE,EAAE,aAAa,EAAE,CAAC,EAAE;SAC3B;QACD;YACE,IAAI,EAAE,gBAAgB;YACtB,GAAG,EAAE,iBAAiB;YACtB,KAAK,EAAE,MAAM;SACd;KACF;CACF,CAAC,CAAC;AAEH;;;;;;;;GAQG;AACI,MAAM,oBAAoB,GAAG,CAClC,MAAc,EACd,kBAA4B,EAI5B,EAAE;;IACF,IAAI,CAAA,MAAA,MAAM,CAAC,QAAQ,0CAAE,IAAI,MAAK,MAAM,EAAE,CAAC;QACrC,OAAO;YACL,IAAI,EAAE,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,kBAAkB,CAAC,EAAE;YAChE,MAAM,EAAE,EAAE,sBAAsB,EAAE,gBAAgB,EAAE,EAAE;SACvD,CAAC;IACJ,CAAC;IACD,OAAO;QACL,IAAI,EAAE,EAAE;QACR,MAAM,EAAE,EAAE,gBAAgB,EAAE,gBAAgB,EAAE,EAAE;KACjD,CAAC;AACJ,CAAC,CAAC;AAjBW,QAAA,oBAAoB,wBAiB/B"}

package/dist/pipeline/src/backends/github/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./GithubBackend";
+export * from "./ciVariables";

package/dist/pipeline/src/backends/github/index.js

@@ -0,0 +1,26 @@
+"use strict";
+
+var __createBinding = this && this.__createBinding || (Object.create ? function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  var desc = Object.getOwnPropertyDescriptor(m, k);
+  if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+    desc = {
+      enumerable: true,
+      get: function () {
+        return m[k];
+      }
+    };
+  }
+  Object.defineProperty(o, k2, desc);
+} : function (o, m, k, k2) {
+  if (k2 === undefined) k2 = k;
+  o[k2] = m[k];
+});
+var __exportStar = this && this.__exportStar || function (m, exports) {
+  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+__exportStar(require("./GithubBackend"), exports);
+__exportStar(require("./ciVariables"), exports);

package/dist/pipeline/src/backends/github/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../pipeline/src/backends/github/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,kDAAgC;AAChC,gDAA8B"}

package/dist/pipeline/src/backends/github/scriptFunctions.d.ts

@@ -0,0 +1,6 @@
+/**
+ * the bash function definitions to prepend to every job script.
+ * github has no pipeline-wide before_script like gitlab, so each job
+ * carries its own definitions.
+ */
+export declare const getGithubScriptFunctionDefinitions: () => string[];