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

package/dist/bundles/cli/index.js

@@ -5845,6 +5845,578 @@ exports.getShell = getShell;
 
 /***/ }),
 
+/***/ 54038:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+
+"use strict";
+
+
+Object.defineProperty(exports, "__esModule", ({
+  value: true
+}));
+exports.GithubBackend = void 0;
+const promises_1 = __nccwpck_require__(91943);
+const path_1 = __nccwpck_require__(16928);
+const createAllJobs_1 = __nccwpck_require__(83671);
+const config_1 = __nccwpck_require__(96925);
+const ciVariables_1 = __nccwpck_require__(25474);
+const createGithubJobs_1 = __nccwpck_require__(14016);
+const githubReleaseJobs_1 = __nccwpck_require__(55611);
+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";
+
+/***/ }),
+
+/***/ 25474:
+/***/ ((__unused_webpack_module, exports) => {
+
+"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 }}"
+};
+
+/***/ }),
+
+/***/ 14016:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+
+"use strict";
+
+
+Object.defineProperty(exports, "__esModule", ({
+  value: true
+}));
+exports.getUploadProviderIds = exports.makeGithubJob = exports.resolveGithubNeeds = exports.githubJobId = void 0;
+const lodash_es_1 = __nccwpck_require__(64284);
+const getInjectVarsScript_1 = __nccwpck_require__(90436);
+const createJobCache_1 = __nccwpck_require__(65644);
+const getEnvironmentVariables_1 = __nccwpck_require__(85855);
+const utils_1 = __nccwpck_require__(20595);
+const gitlab_1 = __nccwpck_require__(13468);
+const scriptFunctions_1 = __nccwpck_require__(75759);
+/**
+ * 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;
+
+/***/ }),
+
+/***/ 55611:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+
+"use strict";
+
+
+Object.defineProperty(exports, "__esModule", ({
+  value: true
+}));
+exports.getGithubReleaseJobs = void 0;
+const runner_1 = __nccwpck_require__(92348);
+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;
+
+/***/ }),
+
+/***/ 99635:
+/***/ (function(__unused_webpack_module, exports, __nccwpck_require__) {
+
+"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(__nccwpck_require__(54038), exports);
+__exportStar(__nccwpck_require__(25474), exports);
+
+/***/ }),
+
+/***/ 75759:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+
+"use strict";
+
+
+Object.defineProperty(exports, "__esModule", ({
+  value: true
+}));
+exports.getGithubScriptFunctionDefinitions = void 0;
+const globalScriptFunctions_1 = __nccwpck_require__(53891);
+/**
+ * github variants of the global script functions where the gitlab
+ * implementation uses gitlab-specific mechanics (e.g. collapsible log
+ * sections use gitlab's `section_start` escape codes, github uses
+ * `::group::` workflow commands). All other functions are plain bash
+ * and shared as-is.
+ */
+const GITHUB_FUNCTION_OVERRIDES = {
+  collapseable_section_start: `local section_title="\${1}"
+  local section_description="\${2:-$section_title}"
+  echo "::group::\${section_description}"`,
+  collapseable_section_end: `echo "::endgroup::"`
+};
+/**
+ * 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.
+ */
+const getGithubScriptFunctionDefinitions = () => [...globalScriptFunctions_1.globalScriptFunctions.values()].map(fn => {
+  const override = GITHUB_FUNCTION_OVERRIDES[fn.name];
+  return override ? `function ${fn.name} () {\n${override.trim()}\n}` : fn.toBashFunction();
+});
+exports.getGithubScriptFunctionDefinitions = getGithubScriptFunctionDefinitions;
+
+/***/ }),
+
 /***/ 22278:
 /***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
 
@@ -5855,6 +6427,7 @@ Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
 exports.GitlabBackend = void 0;
+const promises_1 = __nccwpck_require__(91943);
 const rules_1 = __nccwpck_require__(44565);
 const config_1 = __nccwpck_require__(96925);
 const createAllJobs_1 = __nccwpck_require__(83671);
@@ -5870,6 +6443,12 @@ class GitlabBackend {
     this.type = "gitlab";
     this.generatedFolder = GITLAB_GENERATED_FOLDER;
   }
+  async cleanup() {
+    await (0, promises_1.rm)(this.generatedFolder, {
+      force: true,
+      recursive: true
+    });
+  }
   async createFiles(config) {
     const includes = await this.createIncludes(config);
     const mainFile = {
@@ -6585,11 +7164,14 @@ Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
 exports.getEnabledPipelineTypes = exports.getPipelineBackend = void 0;
+const github_1 = __nccwpck_require__(99635);
 const gitlab_1 = __nccwpck_require__(8475);
 __exportStar(__nccwpck_require__(92474), exports);
 __exportStar(__nccwpck_require__(8475), exports);
+__exportStar(__nccwpck_require__(99635), exports);
 const BACKENDS = {
-  gitlab: () => new gitlab_1.GitlabBackend()
+  gitlab: () => new gitlab_1.GitlabBackend(),
+  github: () => new github_1.GithubBackend()
 };
 const getPipelineBackend = type => {
   const createBackend = BACKENDS[type];
@@ -6941,10 +7523,12 @@ Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
 exports.getCiVariable = void 0;
-const ciVariables_1 = __nccwpck_require__(78506);
+const ciVariables_1 = __nccwpck_require__(25474);
+const ciVariables_2 = __nccwpck_require__(78506);
 const BashExpression_1 = __nccwpck_require__(25354);
 const CI_VARIABLES_PER_PIPELINE_TYPE = {
-  gitlab: ciVariables_1.GITLAB_CI_VARIABLES
+  gitlab: ciVariables_2.GITLAB_CI_VARIABLES,
+  github: ciVariables_1.GITHUB_CI_VARIABLES
 };
 /**
  * resolves a platform-neutral CI variable to a bash expression for the
@@ -8563,7 +9147,7 @@ Object.defineProperty(exports, "__esModule", ({
   value: true
 }));
 exports.DOCKER_REGISTRY = exports.PIPELINE_IMAGE_TAG = void 0;
-exports.PIPELINE_IMAGE_TAG = "next-16388362" || 0;
+exports.PIPELINE_IMAGE_TAG = "next-4e7c6848" || 0;
 exports.DOCKER_REGISTRY = "git.panter.ch:5001/catladder/catladder" || 0;
 
 /***/ }),
@@ -9130,7 +9714,9 @@ const bashExpressionPerPipelineType_1 = __nccwpck_require__(61945);
 const getEnvType_1 = __nccwpck_require__(28254);
 const REVIEW_SLUG = {
   default: "unknown-review-slug",
-  gitlab: new BashExpression_1.BashExpression(`$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; })`)
+  gitlab: new BashExpression_1.BashExpression(`$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; })`),
+  // CL_PR_NUMBER is injected by the github backend at the workflow level
+  github: new BashExpression_1.BashExpression(`$([ -n "$CL_PR_NUMBER" ] && echo "pr$CL_PR_NUMBER" || echo "unknown")`)
 };
 const getReviewSlug = (envConfig, env, pipelineType) => {
   const envType = (0, getEnvType_1.getEnvType)(env, envConfig);
@@ -12320,11 +12906,8 @@ async function generatePipelineFiles(context, pipelineType) {
 exports.generatePipelineFiles = generatePipelineFiles;
 async function generatePipelineFilesForBackend(context, backend) {
   const files = await backend.createFiles(context.config);
-  // first clean up the folder
-  await (0, promises_1.rm)(backend.generatedFolder, {
-    force: true,
-    recursive: true
-  });
+  // first clean up previously generated files
+  await backend.cleanup();
   // write files
   await Promise.all(files.map(async ({
     path,
@@ -155941,7 +156524,7 @@ function differenceInCalendarMonths(dateLeft, dateRight) {
 "use strict";
 
 exports.differenceInCalendarQuarters = differenceInCalendarQuarters;
-var _index = __nccwpck_require__(14016);
+var _index = __nccwpck_require__(91635);
 var _index2 = __nccwpck_require__(65073);
 
 /**
@@ -160353,7 +160936,7 @@ function getOverlappingDaysInIntervals(intervalLeft, intervalRight) {
 
 /***/ }),
 
-/***/ 14016:
+/***/ 91635:
 /***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
 
 "use strict";
@@ -161921,7 +162504,7 @@ Object.keys(_index92).forEach(function (key) {
     },
   });
 });
-var _index93 = __nccwpck_require__(14016);
+var _index93 = __nccwpck_require__(91635);
 Object.keys(_index93).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (key in exports && exports[key] === _index93[key]) return;

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>>;
+}