@catladder/cli 5.5.0 → 5.7.0

package/dist/packages/pipeline/src/postBuildTest/createPostBuildTestJobs.js

@@ -0,0 +1,167 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.assertUniquePostBuildTestNames = exports.createPostBuildTestJobs = exports.postBuildTestJobName = exports.POST_BUILD_TEST_STAGE = void 0;
+const createArtifactsConfig_1 = require("../build/base/createArtifactsConfig");
+const cache_1 = require("../build/node/cache");
+const constants_1 = require("../build/node/constants");
+const packageManagerInstall_1 = require("../build/node/packageManagerInstall");
+const types_1 = require("../build/types");
+const runner_1 = require("../runner");
+const jobs_1 = require("../types/jobs");
+const utils_1 = require("../utils");
+exports.POST_BUILD_TEST_STAGE = "post-build";
+const postBuildTestJobName = (name) => `🔬 ${name}`;
+exports.postBuildTestJobName = postBuildTestJobName;
+const getPostBuildTestsConfig = (context) => {
+    if (context.type === "workspace") {
+        return context.build.config.postBuildTests;
+    }
+    if (context.build.type === "disabled") {
+        return undefined;
+    }
+    return context.build.config.postBuildTests;
+};
+/**
+ * whether the build output is a node project, so the job has to install
+ * the dependencies before running the tests
+ */
+const isNodeBuild = (context) => {
+    if (context.type === "workspace") {
+        return true; // workspace builds are node builds
+    }
+    if (context.build.type === "fromWorkspace") {
+        return true;
+    }
+    if (context.build.type === "standalone") {
+        return (0, types_1.isOfBuildType)(context.build.config, "node", "node-static", "storybook", "meteor");
+    }
+    return false;
+};
+const hasBuildCommand = (buildCommand) => buildCommand !== null && buildCommand !== false;
+/**
+ * whether the build creates an app build job with artifacts. Rails builds
+ * and builds with `buildCommand: false` only build the docker image.
+ */
+const hasBuildArtifacts = (context) => {
+    if (context.type === "workspace") {
+        return hasBuildCommand(context.build.config.buildCommand);
+    }
+    if (context.build.type === "fromWorkspace") {
+        return hasBuildCommand(context.build.workspaceBuildConfig.buildCommand);
+    }
+    if (context.build.type === "standalone") {
+        return (!(0, types_1.isOfBuildType)(context.build.config, "rails") &&
+            hasBuildCommand(context.build.config.buildCommand));
+    }
+    return false;
+};
+const getDefaultImage = (context) => {
+    if (context.type === "component" &&
+        context.build.type === "standalone" &&
+        (0, types_1.isOfBuildType)(context.build.config, "custom")) {
+        // custom builds bring their own toolchain image
+        return context.build.config.jobImage;
+    }
+    return (0, runner_1.getRunnerImage)("jobs-default");
+};
+/**
+ * jobs for `postBuildTests`: they run after the build in the `post-build`
+ * stage, against the build artifacts, and act as quality gates, so a
+ * failing post-build test blocks the deploy.
+ */
+const createPostBuildTestJobs = async (context) => {
+    var _a;
+    // like lint and test: tagged releases deploy what was already tested
+    if (context.trigger === "taggedRelease") {
+        return [];
+    }
+    const tests = Object.entries((_a = getPostBuildTestsConfig(context)) !== null && _a !== void 0 ? _a : {}).filter((entry) => entry[1] !== false);
+    if (tests.length === 0) {
+        return [];
+    }
+    const nodeBuild = isNodeBuild(context);
+    const [packageManagerInstall, nodeCache] = nodeBuild
+        ? await Promise.all([
+            (0, packageManagerInstall_1.getPackageManagerInstall)(context),
+            // pull-only: the build job is the designated cache writer
+            (0, cache_1.getNodeCache)(context, "pull"),
+        ])
+        : [null, null];
+    // components built in a workspace test the workspace build output
+    const from = context.type === "component" && context.build.type === "fromWorkspace"
+        ? { workspace: context.build.workspaceName }
+        : undefined;
+    const buildRequirement = hasBuildArtifacts(context)
+        ? { capability: "buildArtifacts", artifacts: true, strict: true, from }
+        : // no build artifacts (e.g. rails): run after the build (docker image)
+            { capability: "build", artifacts: false, from };
+    return tests.map(([name, test]) => {
+        var _a, _b, _c;
+        const artifactsConfig = (0, createArtifactsConfig_1.createArtifactsConfig)(context.build.dir, test.artifactsReports, test.artifacts);
+        return new jobs_1.CatladderJob({
+            name: (0, exports.postBuildTestJobName)(name),
+            stage: exports.POST_BUILD_TEST_STAGE,
+            envMode: "stagePerEnv",
+            provides: ["qualityGate"],
+            needs: [],
+            requires: [buildRequirement],
+            image: (_a = test.jobImage) !== null && _a !== void 0 ? _a : getDefaultImage(context),
+            services: test.services,
+            // neutral cache declarations, lowered by each backend
+            caches: nodeCache !== null && nodeCache !== void 0 ? nodeCache : undefined,
+            variables: {
+                APP_PATH: context.build.dir,
+                ...(context.type === "component"
+                    ? context.environment.jobOnlyVars.build.envVars
+                    : {}),
+                ...((_b = test.vars) !== null && _b !== void 0 ? _b : {}),
+            },
+            runnerVariables: {
+                ...(nodeBuild ? constants_1.NODE_RUNNER_BUILD_VARIABLES : {}),
+                ...((_c = test.runnerVariables) !== null && _c !== void 0 ? _c : {}),
+            },
+            script: [
+                ...(nodeBuild ? (0, packageManagerInstall_1.ensureNodeVersion)(context) : []),
+                `cd ${context.build.dir}`,
+                ...(packageManagerInstall !== null && packageManagerInstall !== void 0 ? packageManagerInstall : []),
+                ...(0, utils_1.ensureArray)(test.command),
+            ],
+            allow_failure: test.allowFailure,
+            // reports and screenshots are most needed when the tests fail
+            ...(artifactsConfig
+                ? {
+                    artifacts: {
+                        when: "always",
+                        ...artifactsConfig.artifacts,
+                    },
+                }
+                : {}),
+        });
+    });
+};
+exports.createPostBuildTestJobs = createPostBuildTestJobs;
+const jobIdOf = (jobName) => jobName
+    .toLowerCase()
+    .replace(/[^a-z0-9]+/g, "-")
+    .replace(/^-+|-+$/g, "");
+/**
+ * post-build test names are chosen by the user. Github job ids drop the
+ * emoji of the job name, so e.g. a post-build test named `test` would
+ * clash with the `🧪 test` job.
+ */
+const assertUniquePostBuildTestNames = (context, postBuildTestJobs, otherJobs) => {
+    const seenIds = new Set(otherJobs.map((job) => jobIdOf(job.name)));
+    // also catches two post-build tests that only differ in case or
+    // punctuation (e.g. `e2e` and `E2E`)
+    const clash = postBuildTestJobs.find((job) => {
+        const id = jobIdOf(job.name);
+        const isClash = seenIds.has(id);
+        seenIds.add(id);
+        return isClash;
+    });
+    if (clash) {
+        throw new Error(`${context.name}: post-build test '${clash.name}' clashes with another job of the same name, please rename it in postBuildTests`);
+    }
+};
+exports.assertUniquePostBuildTestNames = assertUniquePostBuildTestNames;
+//# sourceMappingURL=createPostBuildTestJobs.js.map

package/dist/packages/pipeline/src/postBuildTest/createPostBuildTestJobs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"createPostBuildTestJobs.js","sourceRoot":"","sources":["../../../../../../../packages/pipeline/src/postBuildTest/createPostBuildTestJobs.ts"],"names":[],"mappings":";;;AAAA,+EAA4E;AAC5E,+CAAmD;AACnD,uDAAsE;AACtE,+EAG6C;AAC7C,0CAA+C;AAC/C,sCAA2C;AAG3C,wCAA6C;AAC7C,oCAAuC;AAG1B,QAAA,qBAAqB,GAAG,YAAY,CAAC;AAE3C,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAE,EAAE,CAAC,MAAM,IAAI,EAAE,CAAC;AAAtD,QAAA,oBAAoB,wBAAkC;AAEnE,MAAM,uBAAuB,GAAG,CAC9B,OAA4C,EACV,EAAE;IACpC,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACjC,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC;IAC7C,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,UAAU,EAAE,CAAC;QACtC,OAAO,SAAS,CAAC;IACnB,CAAC;IACD,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC;AAC7C,CAAC,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,GAAG,CAAC,OAA4C,EAAE,EAAE;IACnE,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACjC,OAAO,IAAI,CAAC,CAAC,mCAAmC;IAClD,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QAC3C,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACxC,OAAO,IAAA,qBAAa,EAClB,OAAO,CAAC,KAAK,CAAC,MAAM,EACpB,MAAM,EACN,aAAa,EACb,WAAW,EACX,QAAQ,CACT,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,YAAqB,EAAE,EAAE,CAChD,YAAY,KAAK,IAAI,IAAI,YAAY,KAAK,KAAK,CAAC;AAElD;;;GAGG;AACH,MAAM,iBAAiB,GAAG,CAAC,OAA4C,EAAE,EAAE;IACzE,IAAI,OAAO,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;QACjC,OAAO,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC;IAC5D,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,eAAe,EAAE,CAAC;QAC3C,OAAO,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,oBAAoB,CAAC,YAAY,CAAC,CAAC;IAC1E,CAAC;IACD,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACxC,OAAO,CACL,CAAC,IAAA,qBAAa,EAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC;YAC7C,eAAe,CAAC,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,YAAY,CAAC,CACnD,CAAC;IACJ,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC,CAAC;AAEF,MAAM,eAAe,GAAG,CAAC,OAA4C,EAAE,EAAE;IACvE,IACE,OAAO,CAAC,IAAI,KAAK,WAAW;QAC5B,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY;QACnC,IAAA,qBAAa,EAAC,OAAO,CAAC,KAAK,CAAC,MAAM,EAAE,QAAQ,CAAC,EAC7C,CAAC;QACD,gDAAgD;QAChD,OAAO,OAAO,CAAC,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC;IACvC,CAAC;IACD,OAAO,IAAA,uBAAc,EAAC,cAAc,CAAC,CAAC;AACxC,CAAC,CAAC;AAEF;;;;GAIG;AACI,MAAM,uBAAuB,GAAG,KAAK,EAC1C,OAA4C,EACnB,EAAE;;IAC3B,qEAAqE;IACrE,IAAI,OAAO,CAAC,OAAO,KAAK,eAAe,EAAE,CAAC;QACxC,OAAO,EAAE,CAAC;IACZ,CAAC;IACD,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC,MAAA,uBAAuB,CAAC,OAAO,CAAC,mCAAI,EAAE,CAAC,CAAC,MAAM,CACzE,CAAC,KAAK,EAA0C,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,KAAK,CACtE,CAAC;IACF,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,MAAM,SAAS,GAAG,WAAW,CAAC,OAAO,CAAC,CAAC;IACvC,MAAM,CAAC,qBAAqB,EAAE,SAAS,CAAC,GAAG,SAAS;QAClD,CAAC,CAAC,MAAM,OAAO,CAAC,GAAG,CAAC;YAChB,IAAA,gDAAwB,EAAC,OAAO,CAAC;YACjC,0DAA0D;YAC1D,IAAA,oBAAY,EAAC,OAAO,EAAE,MAAM,CAAC;SAC9B,CAAC;QACJ,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAEjB,kEAAkE;IAClE,MAAM,IAAI,GACR,OAAO,CAAC,IAAI,KAAK,WAAW,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,eAAe;QACpE,CAAC,CAAC,EAAE,SAAS,EAAE,OAAO,CAAC,KAAK,CAAC,aAAa,EAAE;QAC5C,CAAC,CAAC,SAAS,CAAC;IAChB,MAAM,gBAAgB,GAAgB,iBAAiB,CAAC,OAAO,CAAC;QAC9D,CAAC,CAAC,EAAE,UAAU,EAAE,gBAAgB,EAAE,SAAS,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE;QACvE,CAAC,CAAC,sEAAsE;YACtE,EAAE,UAAU,EAAE,OAAO,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;IAEpD,OAAO,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE;;QAChC,MAAM,eAAe,GAAG,IAAA,6CAAqB,EAC3C,OAAO,CAAC,KAAK,CAAC,GAAG,EACjB,IAAI,CAAC,gBAAgB,EACrB,IAAI,CAAC,SAAS,CACf,CAAC;QACF,OAAO,IAAI,mBAAY,CAAC;YACtB,IAAI,EAAE,IAAA,4BAAoB,EAAC,IAAI,CAAC;YAChC,KAAK,EAAE,6BAAqB;YAC5B,OAAO,EAAE,aAAa;YACtB,QAAQ,EAAE,CAAC,aAAa,CAAC;YACzB,KAAK,EAAE,EAAE;YACT,QAAQ,EAAE,CAAC,gBAAgB,CAAC;YAC5B,KAAK,EAAE,MAAA,IAAI,CAAC,QAAQ,mCAAI,eAAe,CAAC,OAAO,CAAC;YAChD,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,sDAAsD;YACtD,MAAM,EAAE,SAAS,aAAT,SAAS,cAAT,SAAS,GAAI,SAAS;YAC9B,SAAS,EAAE;gBACT,QAAQ,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG;gBAC3B,GAAG,CAAC,OAAO,CAAC,IAAI,KAAK,WAAW;oBAC9B,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,WAAW,CAAC,KAAK,CAAC,OAAO;oBAC/C,CAAC,CAAC,EAAE,CAAC;gBACP,GAAG,CAAC,MAAA,IAAI,CAAC,IAAI,mCAAI,EAAE,CAAC;aACrB;YACD,eAAe,EAAE;gBACf,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,uCAA2B,CAAC,CAAC,CAAC,EAAE,CAAC;gBACjD,GAAG,CAAC,MAAA,IAAI,CAAC,eAAe,mCAAI,EAAE,CAAC;aAChC;YACD,MAAM,EAAE;gBACN,GAAG,CAAC,SAAS,CAAC,CAAC,CAAC,IAAA,yCAAiB,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;gBAChD,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,EAAE;gBACzB,GAAG,CAAC,qBAAqB,aAArB,qBAAqB,cAArB,qBAAqB,GAAI,EAAE,CAAC;gBAChC,GAAG,IAAA,mBAAW,EAAC,IAAI,CAAC,OAAO,CAAC;aAC7B;YACD,aAAa,EAAE,IAAI,CAAC,YAAY;YAChC,8DAA8D;YAC9D,GAAG,CAAC,eAAe;gBACjB,CAAC,CAAC;oBACE,SAAS,EAAE;wBACT,IAAI,EAAE,QAAQ;wBACd,GAAG,eAAe,CAAC,SAAS;qBAC7B;iBACF;gBACH,CAAC,CAAC,EAAE,CAAC;SACR,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC;AA/EW,QAAA,uBAAuB,2BA+ElC;AAEF,MAAM,OAAO,GAAG,CAAC,OAAe,EAAE,EAAE,CAClC,OAAO;KACJ,WAAW,EAAE;KACb,OAAO,CAAC,aAAa,EAAE,GAAG,CAAC;KAC3B,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;AAE7B;;;;GAIG;AACI,MAAM,8BAA8B,GAAG,CAC5C,OAA4C,EAC5C,iBAAiC,EACjC,SAAyB,EACzB,EAAE;IACF,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACnE,gEAAgE;IAChE,qCAAqC;IACrC,MAAM,KAAK,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE;QAC3C,MAAM,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC7B,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAChC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QAChB,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC,CAAC;IACH,IAAI,KAAK,EAAE,CAAC;QACV,MAAM,IAAI,KAAK,CACb,GAAG,OAAO,CAAC,IAAI,sBAAsB,KAAK,CAAC,IAAI,iFAAiF,CACjI,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAnBW,QAAA,8BAA8B,kCAmBzC"}

package/dist/packages/pipeline/src/postBuildTest/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./types";
+export * from "./createPostBuildTestJobs";

package/dist/packages/pipeline/src/postBuildTest/index.js

@@ -0,0 +1,19 @@
+"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("./types"), exports);
+__exportStar(require("./createPostBuildTestJobs"), exports);
+//# sourceMappingURL=index.js.map

package/dist/packages/pipeline/src/postBuildTest/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../../packages/pipeline/src/postBuildTest/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAwB;AACxB,4DAA0C"}

package/dist/packages/pipeline/src/postBuildTest/types.d.ts

@@ -0,0 +1,61 @@
+import type { TestJobCustom } from "../build/types";
+import type { Services } from "../types/gitlab-ci-yml";
+/**
+ * a test job that runs after the build, against the build output, and
+ * blocks the deploy when it fails (e.g. an e2e suite against the
+ * production build with a database service)
+ */
+export type PostBuildTestConfig = TestJobCustom & {
+    /**
+     * command(s) to run, in the build directory (component dir, or the
+     * workspace dir for workspace builds). The build artifacts (e.g.
+     * `dist`, `.next`) are already in place and dependencies are
+     * installed for node builds.
+     *
+     * The command is responsible for starting the app if it needs one,
+     * e.g. via playwright's `webServer` option running `next start`.
+     */
+    command: string | string[];
+    /**
+     * services the job needs, e.g. a database:
+     *
+     * ```ts
+     * services: [{
+     *   name: "postgres:17",
+     *   alias: "postgres",
+     *   variables: { POSTGRES_PASSWORD: "postgres" },
+     * }]
+     * ```
+     *
+     * The service is reachable by its alias as hostname. On github,
+     * `command` and `entrypoint` of a service are not supported.
+     */
+    services?: Services;
+    /**
+     * variables for this job, e.g. `DATABASE_URL` pointing to a service
+     * or `BASE_URL` for the test runner.
+     *
+     * The job gets the build vars of the component (like the build and
+     * test jobs), but not the runtime vars and secrets of the deployed
+     * environment: post-build tests run before the deploy, also for
+     * merge requests, and should use their own services.
+     */
+    vars?: Record<string, string>;
+};
+/**
+ * named post-build tests: each entry becomes its own job in the
+ * `post-build` stage. Set an entry to `false` to disable it (e.g. in an
+ * env-specific override).
+ */
+export type PostBuildTestsConfig = Record<string, PostBuildTestConfig | false>;
+export type WithPostBuildTests = {
+    /**
+     * tests that run after the build against the build output, in the
+     * `post-build` stage between build and deploy. A failing post-build
+     * test blocks the deploy.
+     *
+     * Each entry becomes its own job, e.g. `{ e2e: { command: "pnpm test:e2e" } }`.
+     * Post-build tests don't run in tagged-release pipelines (like lint and test).
+     */
+    postBuildTests?: PostBuildTestsConfig;
+};

package/dist/packages/pipeline/src/postBuildTest/types.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=types.js.map

package/dist/packages/pipeline/src/postBuildTest/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../../../../packages/pipeline/src/postBuildTest/types.ts"],"names":[],"mappings":""}

package/dist/packages/pipeline/src/reviewApps.d.ts

@@ -0,0 +1,38 @@
+import { type ResolvedReviewAppsConfig } from "./reviewAppsPolicy";
+import type { Config } from "./types";
+import type { Context } from "./types/context";
+import type { CatladderJob } from "./types/jobs";
+export * from "./reviewAppsPolicy";
+export declare const getReviewAppsConfig: (config: Config) => ResolvedReviewAppsConfig;
+/**
+ * whether the review deploys sit behind the per-MR/PR deploy switch
+ * instead of running in every pipeline
+ */
+export declare const isReviewDeployGated: (config: ResolvedReviewAppsConfig) => boolean;
+/**
+ * the label whose change switches the review apps on (`labeled` on
+ * opt-in, `unlabeled` on opt-out) or off (the inverse), if the mode is
+ * label-driven at all
+ */
+export declare const getReviewAppsSwitchLabel: (config: ResolvedReviewAppsConfig) => {
+    label: string;
+    deployOn: "labeled" | "unlabeled";
+    stopOn: string;
+} | undefined;
+/**
+ * gitlab: matches a label inside `$CI_MERGE_REQUEST_LABELS`
+ * (comma-separated) — anchored so `x` never matches `no-x`
+ */
+export declare const getGitlabLabelRegex: (label: string) => string;
+/**
+ * gitlab: a draft MR, by its title prefix — the only draft signal every
+ * gitlab version exposes to rules
+ */
+export declare const GITLAB_DRAFT_MR_CONDITION = "$CI_MERGE_REQUEST_TITLE =~ /^\\s*(\\[draft\\]|\\(draft\\)|draft:)/i";
+/**
+ * whether a job belongs to the delivery chain of a review app — the
+ * docker image, the deploy and the post-deploy verification. These jobs
+ * sit behind the review deploy switch; quality jobs (lint, test, audit)
+ * and the app build never do.
+ */
+export declare const isReviewDeliveryJob: (context: Context, job: CatladderJob) => boolean;

package/dist/packages/pipeline/src/reviewApps.js

@@ -0,0 +1,86 @@
+"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 });
+exports.isReviewDeliveryJob = exports.GITLAB_DRAFT_MR_CONDITION = exports.getGitlabLabelRegex = exports.getReviewAppsSwitchLabel = exports.isReviewDeployGated = exports.getReviewAppsConfig = void 0;
+const autoStop_1 = require("./autoStop");
+const reviewAppsPolicy_1 = require("./reviewAppsPolicy");
+__exportStar(require("./reviewAppsPolicy"), exports);
+const getReviewAppsConfig = (config) => {
+    var _a, _b, _c, _d, _e, _f, _g, _h;
+    return ({
+        deploy: (_b = (_a = config.reviewApps) === null || _a === void 0 ? void 0 : _a.deploy) !== null && _b !== void 0 ? _b : "auto",
+        // single colon on purpose: gitlab treats `a::b` labels as scoped and
+        // mutually exclusive, which would make this label and the
+        // `catladder::pin-review` pin label displace each other
+        label: (_d = (_c = config.reviewApps) === null || _c === void 0 ? void 0 : _c.label) !== null && _d !== void 0 ? _d : reviewAppsPolicy_1.DEFAULT_REVIEW_APP_LABEL,
+        skipLabel: (_f = (_e = config.reviewApps) === null || _e === void 0 ? void 0 : _e.skipLabel) !== null && _f !== void 0 ? _f : reviewAppsPolicy_1.DEFAULT_NO_REVIEW_APP_LABEL,
+        drafts: (_h = (_g = config.reviewApps) === null || _g === void 0 ? void 0 : _g.drafts) !== null && _h !== void 0 ? _h : "likeReady",
+    });
+};
+exports.getReviewAppsConfig = getReviewAppsConfig;
+/**
+ * whether the review deploys sit behind the per-MR/PR deploy switch
+ * instead of running in every pipeline
+ */
+const isReviewDeployGated = (config) => config.deploy !== "auto" || config.drafts === "checksOnly";
+exports.isReviewDeployGated = isReviewDeployGated;
+/**
+ * the label whose change switches the review apps on (`labeled` on
+ * opt-in, `unlabeled` on opt-out) or off (the inverse), if the mode is
+ * label-driven at all
+ */
+const getReviewAppsSwitchLabel = (config) => {
+    switch (config.deploy) {
+        case "optIn":
+            return { label: config.label, deployOn: "labeled", stopOn: "unlabeled" };
+        case "optOut":
+            return {
+                label: config.skipLabel,
+                deployOn: "unlabeled",
+                stopOn: "labeled",
+            };
+        default:
+            return undefined;
+    }
+};
+exports.getReviewAppsSwitchLabel = getReviewAppsSwitchLabel;
+/**
+ * gitlab: matches a label inside `$CI_MERGE_REQUEST_LABELS`
+ * (comma-separated) — anchored so `x` never matches `no-x`
+ */
+const getGitlabLabelRegex = (label) => `/${(0, autoStop_1.getPinLabelRegexSource)(label)}/`;
+exports.getGitlabLabelRegex = getGitlabLabelRegex;
+/**
+ * gitlab: a draft MR, by its title prefix — the only draft signal every
+ * gitlab version exposes to rules
+ */
+exports.GITLAB_DRAFT_MR_CONDITION = "$CI_MERGE_REQUEST_TITLE =~ /^\\s*(\\[draft\\]|\\(draft\\)|draft:)/i";
+/**
+ * whether a job belongs to the delivery chain of a review app — the
+ * docker image, the deploy and the post-deploy verification. These jobs
+ * sit behind the review deploy switch; quality jobs (lint, test, audit)
+ * and the app build never do.
+ */
+const isReviewDeliveryJob = (context, job) => {
+    var _a;
+    return context.type === "component" &&
+        context.environment.instance.type === "review" &&
+        (job.stage === "deploy" ||
+            job.stage === "verify" ||
+            ((_a = job.provides) !== null && _a !== void 0 ? _a : []).includes("dockerImage"));
+};
+exports.isReviewDeliveryJob = isReviewDeliveryJob;
+//# sourceMappingURL=reviewApps.js.map

package/dist/packages/pipeline/src/reviewApps.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewApps.js","sourceRoot":"","sources":["../../../../../../packages/pipeline/src/reviewApps.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,yCAAoD;AACpD,yDAI4B;AAK5B,qDAAmC;AAE5B,MAAM,mBAAmB,GAAG,CACjC,MAAc,EACY,EAAE;;IAAC,OAAA,CAAC;QAC9B,MAAM,EAAE,MAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,MAAM,mCAAI,MAAM;QAC3C,qEAAqE;QACrE,0DAA0D;QAC1D,wDAAwD;QACxD,KAAK,EAAE,MAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,KAAK,mCAAI,2CAAwB;QAC3D,SAAS,EAAE,MAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,SAAS,mCAAI,8CAA2B;QACtE,MAAM,EAAE,MAAA,MAAA,MAAM,CAAC,UAAU,0CAAE,MAAM,mCAAI,WAAW;KACjD,CAAC,CAAA;CAAA,CAAC;AAVU,QAAA,mBAAmB,uBAU7B;AAEH;;;GAGG;AACI,MAAM,mBAAmB,GAAG,CAAC,MAAgC,EAAE,EAAE,CACtE,MAAM,CAAC,MAAM,KAAK,MAAM,IAAI,MAAM,CAAC,MAAM,KAAK,YAAY,CAAC;AADhD,QAAA,mBAAmB,uBAC6B;AAE7D;;;;GAIG;AACI,MAAM,wBAAwB,GAAG,CACtC,MAAgC,EAGpB,EAAE;IACd,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;QACtB,KAAK,OAAO;YACV,OAAO,EAAE,KAAK,EAAE,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC;QAC3E,KAAK,QAAQ;YACX,OAAO;gBACL,KAAK,EAAE,MAAM,CAAC,SAAS;gBACvB,QAAQ,EAAE,WAAW;gBACrB,MAAM,EAAE,SAAS;aAClB,CAAC;QACJ;YACE,OAAO,SAAS,CAAC;IACrB,CAAC;AACH,CAAC,CAAC;AAjBW,QAAA,wBAAwB,4BAiBnC;AAEF;;;GAGG;AACI,MAAM,mBAAmB,GAAG,CAAC,KAAa,EAAU,EAAE,CAC3D,IAAI,IAAA,iCAAsB,EAAC,KAAK,CAAC,GAAG,CAAC;AAD1B,QAAA,mBAAmB,uBACO;AAEvC;;;GAGG;AACU,QAAA,yBAAyB,GACpC,qEAAqE,CAAC;AAExE;;;;;GAKG;AACI,MAAM,mBAAmB,GAAG,CAAC,OAAgB,EAAE,GAAiB,EAAE,EAAE;;IACzE,OAAA,OAAO,CAAC,IAAI,KAAK,WAAW;QAC5B,OAAO,CAAC,WAAW,CAAC,QAAQ,CAAC,IAAI,KAAK,QAAQ;QAC9C,CAAC,GAAG,CAAC,KAAK,KAAK,QAAQ;YACrB,GAAG,CAAC,KAAK,KAAK,QAAQ;YACtB,CAAC,MAAA,GAAG,CAAC,QAAQ,mCAAI,EAAE,CAAC,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC,CAAA;CAAA,CAAC;AALrC,QAAA,mBAAmB,uBAKkB"}

package/dist/packages/pipeline/src/reviewAppsPolicy.d.ts

@@ -0,0 +1,46 @@
+/**
+ * the review-app deploy policy — dependency-free, so catci (the CI
+ * companion bundle) can import it without dragging in the pipeline.
+ */
+/**
+ * when the review apps of a merge request / pull request deploy:
+ * - auto: every MR/PR deploys its review apps (default)
+ * - manual: never on their own — one "deploy review" switch per MR/PR
+ *   (gitlab: a manual job in the pipeline, github: a dispatch workflow)
+ * - optIn: only while the MR/PR carries the `label`
+ * - optOut: unless the MR/PR carries the `skipLabel`
+ */
+export type ReviewAppsDeployMode = "auto" | "manual" | "optIn" | "optOut";
+/**
+ * what a draft MR/PR runs:
+ * - likeReady: the same as a ready one, review apps included (default)
+ * - checksOnly: tests, lint and audit only — the review apps deploy once it is
+ *   marked ready
+ * - skip: no pipeline at all
+ */
+export type ReviewAppsDraftsMode = "likeReady" | "checksOnly" | "skip";
+export declare const DEFAULT_REVIEW_APP_LABEL = "catladder:review-app";
+export declare const DEFAULT_NO_REVIEW_APP_LABEL = "catladder:no-review-app";
+export type ResolvedReviewAppsConfig = {
+    deploy: ReviewAppsDeployMode;
+    label: string;
+    skipLabel: string;
+    drafts: ReviewAppsDraftsMode;
+};
+/**
+ * the state of a merge request / pull request the deploy decision
+ * depends on
+ */
+export type ReviewAppsMrState = {
+    labels: string[];
+    draft: boolean;
+};
+/**
+ * whether the review apps of an MR/PR in the given state deploy
+ * automatically. An explicit request (playing the gate job, dispatching
+ * the deploy workflow) always deploys and doesn't consult this.
+ */
+export declare const shouldAutoDeployReviewApps: (config: ResolvedReviewAppsConfig, { labels, draft }: ReviewAppsMrState) => {
+    deploy: boolean;
+    reason: string;
+};

package/dist/packages/pipeline/src/reviewAppsPolicy.js

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.shouldAutoDeployReviewApps = exports.DEFAULT_NO_REVIEW_APP_LABEL = exports.DEFAULT_REVIEW_APP_LABEL = void 0;
+exports.DEFAULT_REVIEW_APP_LABEL = "catladder:review-app";
+exports.DEFAULT_NO_REVIEW_APP_LABEL = "catladder:no-review-app";
+/**
+ * whether the review apps of an MR/PR in the given state deploy
+ * automatically. An explicit request (playing the gate job, dispatching
+ * the deploy workflow) always deploys and doesn't consult this.
+ */
+const shouldAutoDeployReviewApps = (config, { labels, draft }) => {
+    if (draft && config.drafts !== "likeReady") {
+        return { deploy: false, reason: "drafts don't deploy review apps" };
+    }
+    switch (config.deploy) {
+        case "auto":
+            return { deploy: true, reason: "review apps deploy automatically" };
+        case "manual":
+            return {
+                deploy: false,
+                reason: "review apps only deploy on request (deploy: manual)",
+            };
+        case "optIn":
+            return labels.includes(config.label)
+                ? { deploy: true, reason: `the '${config.label}' label is set` }
+                : { deploy: false, reason: `the '${config.label}' label is not set` };
+        case "optOut":
+            return labels.includes(config.skipLabel)
+                ? { deploy: false, reason: `the '${config.skipLabel}' label is set` }
+                : {
+                    deploy: true,
+                    reason: `the '${config.skipLabel}' label is not set`,
+                };
+    }
+};
+exports.shouldAutoDeployReviewApps = shouldAutoDeployReviewApps;
+//# sourceMappingURL=reviewAppsPolicy.js.map

package/dist/packages/pipeline/src/reviewAppsPolicy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"reviewAppsPolicy.js","sourceRoot":"","sources":["../../../../../../packages/pipeline/src/reviewAppsPolicy.ts"],"names":[],"mappings":";;;AAuBa,QAAA,wBAAwB,GAAG,sBAAsB,CAAC;AAClD,QAAA,2BAA2B,GAAG,yBAAyB,CAAC;AAkBrE;;;;GAIG;AACI,MAAM,0BAA0B,GAAG,CACxC,MAAgC,EAChC,EAAE,MAAM,EAAE,KAAK,EAAqB,EACC,EAAE;IACvC,IAAI,KAAK,IAAI,MAAM,CAAC,MAAM,KAAK,WAAW,EAAE,CAAC;QAC3C,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,iCAAiC,EAAE,CAAC;IACtE,CAAC;IACD,QAAQ,MAAM,CAAC,MAAM,EAAE,CAAC;QACtB,KAAK,MAAM;YACT,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,kCAAkC,EAAE,CAAC;QACtE,KAAK,QAAQ;YACX,OAAO;gBACL,MAAM,EAAE,KAAK;gBACb,MAAM,EAAE,qDAAqD;aAC9D,CAAC;QACJ,KAAK,OAAO;YACV,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAK,CAAC;gBAClC,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,QAAQ,MAAM,CAAC,KAAK,gBAAgB,EAAE;gBAChE,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,MAAM,CAAC,KAAK,oBAAoB,EAAE,CAAC;QAC1E,KAAK,QAAQ;YACX,OAAO,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC;gBACtC,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,MAAM,CAAC,SAAS,gBAAgB,EAAE;gBACrE,CAAC,CAAC;oBACE,MAAM,EAAE,IAAI;oBACZ,MAAM,EAAE,QAAQ,MAAM,CAAC,SAAS,oBAAoB;iBACrD,CAAC;IACV,CAAC;AACH,CAAC,CAAC;AA3BW,QAAA,0BAA0B,8BA2BrC"}

package/dist/packages/pipeline/src/types/config.d.ts

@@ -11,6 +11,7 @@ import type { CatladderStore } from "../store";
 import type { AgentSkillsConfig } from "../agentSkills/types";
 import type { ProjectImageConfig } from "../customImages/projectImages";
 import type { VerifyConfig } from "../verify/types";
+import type { ReviewAppsDeployMode, ReviewAppsDraftsMode } from "../reviewAppsPolicy";
 export declare const ALL_PIPELINE_TRIGGERS: readonly ["mainBranch", "mr", "taggedRelease"];
 export type PipelineTrigger = (typeof ALL_PIPELINE_TRIGGERS)[number];
 /**
@@ -492,6 +493,60 @@ export type Config<C extends ConfigProps = never> = {
          */
         pinLabel?: string | false;
     };
+    /**
+     * when merge requests / pull requests deploy their review apps —
+     * useful when many MRs/PRs are opened (e.g. by agents) and most of
+     * them don't need a running instance.
+     *
+     * With anything but the defaults, the delivery chain of every
+     * component's review app (docker image → deploy → verify) waits for
+     * ONE switch per MR/PR instead of running in every pipeline; tests,
+     * lint and audit always run:
+     * - gitlab: a `🚀 deploy review` job (manual, or automatic when the
+     *   label policy says so). Label changes only apply to the next
+     *   pipeline — `catladder mr review-app-on/off` sets the label and
+     *   triggers one.
+     * - github: the review workflow decides at its start (labels, draft)
+     *   and deploys in the same run when the policy says so. Later
+     *   changes go through a `▶️ catladder deploy review` workflow,
+     *   dispatched by the review workflow once green (when the policy now
+     *   says deploy), by adding/removing the label, or by hand with the
+     *   PR number. Switching the label off stops the review apps.
+     *
+     * Per-component `deploy.when` of the review env is ignored then — the
+     * switch covers all components.
+     */
+    reviewApps?: {
+        /**
+         * - auto: every MR/PR deploys (default)
+         * - manual: only on request (play the gate job / dispatch the
+         *   workflow)
+         * - optIn: only while the MR/PR carries `label`
+         * - optOut: unless the MR/PR carries `skipLabel`
+         * @defaultValue "auto"
+         */
+        deploy?: ReviewAppsDeployMode;
+        /**
+         * the opt-in label
+         * @defaultValue "catladder:review-app"
+         */
+        label?: string;
+        /**
+         * the opt-out label
+         * @defaultValue "catladder:no-review-app"
+         */
+        skipLabel?: string;
+        /**
+         * what draft MRs/PRs run:
+         * - likeReady: the same as ready ones (default)
+         * - checksOnly: tests, lint and audit — the review apps deploy once the
+         *   MR/PR is marked ready
+         * - skip: nothing (gitlab: marking an MR ready doesn't start a
+         *   pipeline, the next push does)
+         * @defaultValue "likeReady"
+         */
+        drafts?: ReviewAppsDraftsMode;
+    };
     /**
      * additional vars only for the runner in all jobs.
      */

package/dist/packages/pipeline/src/types/config.js.map

@@ -1 +1 @@
-{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../../../packages/pipeline/src/types/config.ts"],"names":[],"mappings":";;;AAea,QAAA,qBAAqB,GAAG;IACnC,YAAY;IACZ,IAAI;IACJ,eAAe;CACP,CAAC;AAoBJ,MAAM,eAAe,GAAG,CAC7B,OAA2B,EACO,EAAE,CACpC,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,IAAI,QAAQ,IAAI,OAAO,CAAC;AAH5D,QAAA,eAAe,mBAG6C;AAElE,MAAM,gBAAgB,GAAG,CAC9B,CAA0B,EAC1B,CAAqB,EACZ,EAAE;IACX,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,KAAK;QAAE,OAAO,KAAK,CAAC;IACjD,IAAI,IAAA,uBAAe,EAAC,CAAC,CAAC;QAAE,OAAO,IAAA,uBAAe,EAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,CAAC;IAC3E,OAAO,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC,CAAC;AAPW,QAAA,gBAAgB,oBAO3B;AAEF;;;GAGG;AACU,QAAA,SAAS,GAAG;IACvB,GAAG,EAAE;QACH,QAAQ,EAAE,CAAC,YAAY,CAAC;KACzB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,CAAC,IAAI,CAAC;KACjB;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,EAAE;KACb;CACO,CAAC;AAEE,QAAA,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAS,CAAC,CAAC;AACtC,QAAA,iBAAiB,GAAG,oBAAyB,CAAC;AAGpD,MAAM,aAAa,GAAG,CAAC,GAAW,EAAkB,EAAE;IAC3D,OAAO,GAAG,IAAI,iBAAS,CAAC;AAC1B,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB;AAmMF;;;GAGG;AACI,MAAM,oBAAoB,GAAG,CAClC,YAA4C,EAC5C,GAAW,EACoB,EAAE,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAG,GAAG,CAAC,KAAI,SAAS,CAAC;AAHxD,QAAA,oBAAoB,wBAGoC;AAE9D,MAAM,qBAAqB,GAAG,CACnC,YAA4C,EAC5C,GAAW,EACF,EAAE,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAG,GAAG,CAAC,MAAK,KAAK,CAAC;AAH/B,QAAA,qBAAqB,yBAGU"}
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../../../packages/pipeline/src/types/config.ts"],"names":[],"mappings":";;;AAmBa,QAAA,qBAAqB,GAAG;IACnC,YAAY;IACZ,IAAI;IACJ,eAAe;CACP,CAAC;AAoBJ,MAAM,eAAe,GAAG,CAC7B,OAA2B,EACO,EAAE,CACpC,OAAO,OAAO,KAAK,QAAQ,IAAI,OAAO,KAAK,IAAI,IAAI,QAAQ,IAAI,OAAO,CAAC;AAH5D,QAAA,eAAe,mBAG6C;AAElE,MAAM,gBAAgB,GAAG,CAC9B,CAA0B,EAC1B,CAAqB,EACZ,EAAE;IACX,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,KAAK;QAAE,OAAO,KAAK,CAAC;IACjD,IAAI,IAAA,uBAAe,EAAC,CAAC,CAAC;QAAE,OAAO,IAAA,uBAAe,EAAC,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,KAAK,CAAC,CAAC,MAAM,CAAC;IAC3E,OAAO,CAAC,KAAK,CAAC,CAAC;AACjB,CAAC,CAAC;AAPW,QAAA,gBAAgB,oBAO3B;AAEF;;;GAGG;AACU,QAAA,SAAS,GAAG;IACvB,GAAG,EAAE;QACH,QAAQ,EAAE,CAAC,YAAY,CAAC;KACzB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,CAAC,IAAI,CAAC;KACjB;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,EAAE;KACb;CACO,CAAC;AAEE,QAAA,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAS,CAAC,CAAC;AACtC,QAAA,iBAAiB,GAAG,oBAAyB,CAAC;AAGpD,MAAM,aAAa,GAAG,CAAC,GAAW,EAAkB,EAAE;IAC3D,OAAO,GAAG,IAAI,iBAAS,CAAC;AAC1B,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB;AAmMF;;;GAGG;AACI,MAAM,oBAAoB,GAAG,CAClC,YAA4C,EAC5C,GAAW,EACoB,EAAE,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAG,GAAG,CAAC,KAAI,SAAS,CAAC;AAHxD,QAAA,oBAAoB,wBAGoC;AAE9D,MAAM,qBAAqB,GAAG,CACnC,YAA4C,EAC5C,GAAW,EACF,EAAE,CAAC,CAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAG,GAAG,CAAC,MAAK,KAAK,CAAC;AAH/B,QAAA,qBAAqB,yBAGU"}

package/dist/packages/pipeline/src/types/jobs.d.ts

@@ -16,7 +16,7 @@ export type CatladderJobCache = GitlabJobCache & {
     cacheId?: string;
     redundantOnExactHitOf?: string;
 };
-export declare const BASE_STAGES: readonly ["setup", "test", "build", "deploy", "verify", "agents", "rollback", "stop"];
+export declare const BASE_STAGES: readonly ["setup", "test", "build", "post-build", "deploy", "verify", "agents", "rollback", "stop"];
 export type BaseStage = (typeof BASE_STAGES)[number];
 export type CatladderJobNeed = string | {
     job: string;
@@ -130,7 +130,7 @@ export type CatladderJobCore<S = BaseStage> = {
     /**
      * the capabilities this job provides to other jobs.
      * If not set, it is derived from the stage:
-     * build -> "build", test -> "qualityGate", deploy -> "deployment"
+     * build -> "build", test and post-build -> "qualityGate", deploy -> "deployment"
      */
     provides?: CapabilityName[];
     /**

package/dist/packages/pipeline/src/types/jobs.js

@@ -6,6 +6,7 @@ exports.BASE_STAGES = [
     "setup",
     "test",
     "build",
+    "post-build",
     "deploy",
     "verify",
     "agents",

package/dist/packages/pipeline/src/types/jobs.js.map

@@ -1 +1 @@
-{"version":3,"file":"jobs.js","sourceRoot":"","sources":["../../../../../../../packages/pipeline/src/types/jobs.ts"],"names":[],"mappings":";;;AAIA,8DAA2D;AAsB9C,QAAA,WAAW,GAAG;IACzB,OAAO;IACP,MAAM;IACN,OAAO;IACP,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,MAAM;CACE,CAAC;AAWE,QAAA,YAAY,GAAG;IAC1B,OAAO;IACP,gBAAgB;IAChB,aAAa;IACb,aAAa;IACb,YAAY;CACJ,CAAC;AAuOX;;;;;;;GAOG;AACH,4JAA4J;AAC5J,MAAa,YAAY;IACvB,YAAY,IAAyB;QACnC,uDAAuD;QACvD,2DAA2D;QAC3D,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAA,iCAAe,EAAC,IAAI,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,CAAC,IAAI,CACT,GAAkD;QAElD,OAAO,GAAG,YAAY,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC;IACnE,CAAC;CACF;AAZD,oCAYC"}
+{"version":3,"file":"jobs.js","sourceRoot":"","sources":["../../../../../../../packages/pipeline/src/types/jobs.ts"],"names":[],"mappings":";;;AAIA,8DAA2D;AAsB9C,QAAA,WAAW,GAAG;IACzB,OAAO;IACP,MAAM;IACN,OAAO;IACP,YAAY;IACZ,QAAQ;IACR,QAAQ;IACR,QAAQ;IACR,UAAU;IACV,MAAM;CACE,CAAC;AAWE,QAAA,YAAY,GAAG;IAC1B,OAAO;IACP,gBAAgB;IAChB,aAAa;IACb,aAAa;IACb,YAAY;CACJ,CAAC;AAuOX;;;;;;;GAOG;AACH,4JAA4J;AAC5J,MAAa,YAAY;IACvB,YAAY,IAAyB;QACnC,uDAAuD;QACvD,2DAA2D;QAC3D,MAAM,CAAC,MAAM,CAAC,IAAI,EAAE,IAAA,iCAAe,EAAC,IAAI,CAAC,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,CAAC,IAAI,CACT,GAAkD;QAElD,OAAO,GAAG,YAAY,YAAY,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,YAAY,CAAC,GAAG,CAAC,CAAC;IACnE,CAAC;CACF;AAZD,oCAYC"}