@catladder/cli 0.0.0-next-31a23584 → 0.0.0-next-41642e39

package/dist/bundles/catenv/index.js

@@ -5203,7 +5203,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.getNodeCache = exports.getNodeModulesCache = exports.getYarnCache = void 0;
-const lodash_es_1 = __nccwpck_require__(50866);
 const path_1 = __nccwpck_require__(16928);
 const slugify_1 = __importDefault(__nccwpck_require__(21396));
 /**
@@ -5212,15 +5211,37 @@ const slugify_1 = __importDefault(__nccwpck_require__(21396));
  * exact-lockfile hit (github skips the ~0.6GB download on warm runs)
  */
 const NODE_MODULES_CACHE_ID = "node-modules";
-const getYarnCache = async (context, policy = "pull-push") => {
+/**
+ * the directory whose caches this job uses. Components that are part of
+ * a shared workspace use the workspace root's caches: the install
+ * operates on the whole workspace, and the workspace build job is the
+ * one that populates the slots. Historically these component jobs
+ * (verify, docker) read a separate key family that no job ever saved,
+ * so they always started cold. Standalone components and the workspace
+ * jobs themselves keep using their own build dir (unchanged keys).
+ */
+const getCacheBaseDir = async (context) => {
+    var _a;
     const packageManagerInfo = await context.packageManagerInfo;
     const componentIsInWorkspace = context.type === "component" &&
         "componentIsInWorkspace" in packageManagerInfo &&
         packageManagerInfo.componentIsInWorkspace;
+    if (!componentIsInWorkspace)
+        return context.build.dir;
+    // the workspace build's dir when the component references one,
+    // otherwise the repo root (packageManager.ts resolves workspace
+    // membership against the root)
+    return context.build.type === "fromWorkspace"
+        ? ((_a = context.build.workspaceBuildConfig.dir) !== null && _a !== void 0 ? _a : ".")
+        : ".";
+};
+const getYarnCache = async (context, policy = "pull-push") => {
+    const baseDir = await getCacheBaseDir(context);
     return [
         {
-            scope: componentIsInWorkspace ? "global" : "buildDir",
-            pathMode: componentIsInWorkspace ? "absolute" : "relative",
+            scope: "buildDir",
+            pathMode: "relative",
+            buildDir: baseDir,
             key: "yarn",
             policy,
             paths: [".yarn"],
@@ -5237,52 +5258,28 @@ const getYarnCache = async (context, policy = "pull-push") => {
 };
 exports.getYarnCache = getYarnCache;
 const getNodeModulesCache = async (context, policy = "pull-push") => {
-    var _a, _b;
     const packageManagerInfo = await context.packageManagerInfo;
-    const componentIsInWorkspace = context.type === "component" &&
-        "componentIsInWorkspace" in packageManagerInfo &&
-        packageManagerInfo.componentIsInWorkspace;
-    const { isClassic, workspaces } = packageManagerInfo;
+    const baseDir = await getCacheBaseDir(context);
+    const { isClassic } = packageManagerInfo;
     // We intentionally do not use the contents of yarn.lock as a cache key, as yarn install should always guarantee that the files are updated, but it can still use part of the cache if not all packages are up-to-date.
     // It would slow down all pipelines whenever one adds a new dependency as it will need to download all node_modules again.
     return [
         {
             scope: "global",
             pathMode: "absolute",
-            // if component is in a shared workspace, use workspace cache. use individual cache else
-            key: componentIsInWorkspace
-                ? "node-modules-workspace"
-                : (0, slugify_1.default)(context.build.dir) + "-node-modules", // we use the dirname, not the component name, because in certain cases we have two apps in the same directory and want to share the cache, e.g. when having storybook in the same package.json
+            // we use the dirname, not the component name, because in certain cases we have two apps in the same directory and want to share the cache, e.g. when having storybook in the same package.json
+            key: (0, slugify_1.default)(baseDir) + "-node-modules",
             // content-key for immutable-cache backends (github); the lockfile
             // decides whether the cached content could have changed (absolute
-            // pathMode: resolve the standalone component's lockfile explicitly)
-            keyFiles: [
-                componentIsInWorkspace
-                    ? "yarn.lock"
-                    : (0, path_1.join)(context.build.dir, "yarn.lock"),
-            ],
+            // pathMode: resolve the lockfile explicitly)
+            keyFiles: [(0, path_1.join)(baseDir, "yarn.lock")],
             // referenced by the yarn cache: an exact hit here makes the yarn
             // zips unnecessary (see redundantOnExactHitOf on getYarnCache)
             cacheId: NODE_MODULES_CACHE_ID,
             policy,
             paths: [
-                ...(componentIsInWorkspace
-                    ? (0, lodash_es_1.uniq)([
-                        "node_modules",
-                        ...((_a = workspaces.map((w) => (0, path_1.join)(w.location, "node_modules"))) !== null && _a !== void 0 ? _a : []),
-                        ...(!isClassic
-                            ? [
-                                ".yarn/install-state.gz",
-                                ...((_b = workspaces.map((w) => (0, path_1.join)(w.location, ".yarn/install-state.gz"))) !== null && _b !== void 0 ? _b : []),
-                            ]
-                            : []),
-                    ])
-                    : [
-                        (0, path_1.join)(context.build.dir, "node_modules"),
-                        ...(!isClassic
-                            ? [(0, path_1.join)(context.build.dir, ".yarn/install-state.gz")]
-                            : []),
-                    ]),
+                (0, path_1.join)(baseDir, "node_modules"),
+                ...(!isClassic ? [(0, path_1.join)(baseDir, ".yarn/install-state.gz")] : []),
             ],
         },
     ];
@@ -7047,7 +7044,7 @@ const variables_1 = __nccwpck_require__(98885);
 exports.DEPLOY_JOB_NAME = "🚀 Deploy";
 class DeployJob extends jobs_1.CatladderJob {
     constructor(context, jobDefinition) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         const hasDocker = (0, docker_1.requiresDockerBuild)(context);
         const isStoppable = (0, utils_1.contextIsStoppable)(context);
         const autoStop = context.environment.envType === "review"
@@ -7125,6 +7122,8 @@ class DeployJob extends jobs_1.CatladderJob {
             caches: jobDefinition.cache,
             artifacts: jobDefinition.artifacts,
             services: jobDefinition.services,
+            pages: jobDefinition.pages,
+            allow_failure: (_e = jobDefinition.allow_failure) !== null && _e !== void 0 ? _e : deployConfig === null || deployConfig === void 0 ? void 0 : deployConfig.allowFailure,
             envMode: "stagePerEnv", // makes it easier to run manual tasks er env
             needs: [],
             requires: [
@@ -7144,8 +7143,8 @@ class DeployJob extends jobs_1.CatladderJob {
             },
             runnerVariables: {
                 ...variables_1.DEPLOY_RUNNER_VARIABLES,
-                ...((_e = jobDefinition.runnerVariables) !== null && _e !== void 0 ? _e : {}),
-                ...(deployConfig ? ((_f = deployConfig.runnerVariables) !== null && _f !== void 0 ? _f : {}) : {}),
+                ...((_f = jobDefinition.runnerVariables) !== null && _f !== void 0 ? _f : {}),
+                ...(deployConfig ? ((_g = deployConfig.runnerVariables) !== null && _g !== void 0 ? _g : {}) : {}),
             },
             environment: isStoppable
                 ? {
@@ -8723,6 +8722,9 @@ const createCustomDeployJobs = async (context) => {
         deploy: {
             image: (_b = deployConfig.jobImage) !== null && _b !== void 0 ? _b : (0, runner_1.getRunnerImage)("jobs-default"),
             cache: (0, getAllCacheConfigsFromConfig_1.getAllCacheConfigsFromConfig)(context, deployConfig),
+            artifacts: deployConfig.artifactsPaths
+                ? { paths: deployConfig.artifactsPaths }
+                : undefined,
             script: [
                 `cd ${context.build.dir}`,
                 ...(deployConfig.requiresYarnInstall ? yarnInstall : []),
@@ -8843,9 +8845,11 @@ const custom_1 = __nccwpck_require__(36394);
 const dockerTag_1 = __nccwpck_require__(59231);
 const kubernetes_1 = __nccwpck_require__(94469);
 const npmPackage_1 = __nccwpck_require__(79462);
+const pages_1 = __nccwpck_require__(66387);
 __exportStar(__nccwpck_require__(2691), exports);
 __exportStar(__nccwpck_require__(94469), exports);
 __exportStar(__nccwpck_require__(79462), exports);
+__exportStar(__nccwpck_require__(66387), exports);
 __exportStar(__nccwpck_require__(71446), exports);
 __exportStar(__nccwpck_require__(3537), exports);
 exports.DEPLOY_TYPES = {
@@ -8854,6 +8858,7 @@ exports.DEPLOY_TYPES = {
     dockerTag: dockerTag_1.DOCKER_TAG_DEPLOY_TYPE,
     "google-cloudrun": cloudRun_1.GCLOUD_RUN_DEPLOY_TYPE,
     npmPackage: npmPackage_1.NPM_PACKAGE_DEPLOY_TYPE,
+    pages: pages_1.PAGES_DEPLOY_TYPE,
 };
 //# sourceMappingURL=index.js.map
 
@@ -9387,10 +9392,91 @@ exports.NPM_PACKAGE_DEPLOY_TYPE = {
     jobs: deployJob_1.createNpmPackageDeployJobs,
     defaults: () => ({}),
     additionalSecretKeys: (ctx) => 
-    // publish credentials don't exist for the local env
-    ctx.envType !== "local"
-        ? [{ key: exports.NPM_TOKEN_SECRET_KEY, hidden: true }]
-        : [],
+    // publish credentials don't exist for the local env. Not hidden:
+    // the user sets the token via `catladder project secrets-set`
+    // (hidden is for machine-provisioned credentials)
+    ctx.envType !== "local" ? [{ key: exports.NPM_TOKEN_SECRET_KEY }] : [],
+    getAdditionalEnvVars: () => ({}),
+};
+//# sourceMappingURL=index.js.map
+
+/***/ }),
+
+/***/ 56173:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.createPagesDeployJobs = void 0;
+const getAllCacheConfigsFromConfig_1 = __nccwpck_require__(19034);
+const yarn_1 = __nccwpck_require__(59874);
+const runner_1 = __nccwpck_require__(71065);
+const base_1 = __nccwpck_require__(93664);
+const types_1 = __nccwpck_require__(71446);
+const createPagesDeployJobs = async (context) => {
+    var _a, _b, _c;
+    const deployConfig = (_a = context.deploy) === null || _a === void 0 ? void 0 : _a.config;
+    if (!(0, types_1.isOfDeployType)(deployConfig, "pages")) {
+        // should not happen
+        throw new Error("deploy config is not pages");
+    }
+    if (context.pipelineType === "github") {
+        // don't fail the whole github generation of a multi-backend project
+        console.warn(`component "${context.name}": the pages deploy type is not yet supported on the github backend — no deploy jobs generated`);
+        return [];
+    }
+    // review environments publish under their own path prefix (gitlab
+    // parallel deployments) — every merge request gets a site preview
+    const pathPrefix = context.environment.envType === "review" ? "mr-$CI_MERGE_REQUEST_IID" : "";
+    const publishDir = (_b = deployConfig.publishDir) !== null && _b !== void 0 ? _b : "public";
+    const yarnInstall = await (0, yarn_1.getYarnInstall)(context, {
+        noCustomPostInstall: true,
+    });
+    return (0, base_1.createDeployementJobs)(context, {
+        deploy: {
+            image: (_c = deployConfig.jobImage) !== null && _c !== void 0 ? _c : (0, runner_1.getRunnerImage)("jobs-default"),
+            cache: (0, getAllCacheConfigsFromConfig_1.getAllCacheConfigsFromConfig)(context, deployConfig),
+            artifacts: { paths: [publishDir] },
+            pages: { path_prefix: pathPrefix },
+            script: [
+                `cd ${context.build.dir}`,
+                ...(deployConfig.requiresYarnInstall ? yarnInstall : []),
+                ...deployConfig.script,
+                // the gitlab environment url should point at the published site
+                // (the base deploy job reports $ROOT_URL as environment url)
+                `export ROOT_URL="$CI_PAGES_URL${pathPrefix ? `/${pathPrefix}` : ""}"`,
+            ],
+            variables: {},
+            runnerVariables: {
+                // exposed so build scripts can adjust e.g. their base url
+                PAGES_PREFIX: pathPrefix,
+                // a pages deploy runs a full site build — the generic deploy-job
+                // resources (200Mi/400Mi) OOM on any real yarn install + build
+                KUBERNETES_MEMORY_REQUEST: "1Gi",
+                KUBERNETES_MEMORY_LIMIT: "4Gi",
+            },
+        },
+    });
+};
+exports.createPagesDeployJobs = createPagesDeployJobs;
+//# sourceMappingURL=deployJob.js.map
+
+/***/ }),
+
+/***/ 66387:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.PAGES_DEPLOY_TYPE = void 0;
+const deployJob_1 = __nccwpck_require__(56173);
+exports.PAGES_DEPLOY_TYPE = {
+    jobs: deployJob_1.createPagesDeployJobs,
+    // a broken site publish should not block the rest of the pipeline
+    defaults: () => ({ allowFailure: true }),
+    additionalSecretKeys: () => [],
     getAdditionalEnvVars: () => ({}),
 };
 //# sourceMappingURL=index.js.map
@@ -9469,6 +9555,7 @@ __exportStar(__nccwpck_require__(72025), exports);
 __exportStar(__nccwpck_require__(12152), exports);
 __exportStar(__nccwpck_require__(8030), exports);
 __exportStar(__nccwpck_require__(14571), exports);
+__exportStar(__nccwpck_require__(88510), exports);
 const isOfDeployType = (t, ...types) => {
     return t && types.includes(t.type) ? true : false;
 };
@@ -9503,6 +9590,16 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 
 /***/ }),
 
+/***/ 88510:
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+//# sourceMappingURL=pages.js.map
+
+/***/ }),
+
 /***/ 3537:
 /***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
 

package/dist/bundles/cli/index.js

@@ -11196,7 +11196,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
 exports.getNodeCache = exports.getNodeModulesCache = exports.getYarnCache = void 0;
-const lodash_es_1 = __nccwpck_require__(50866);
 const path_1 = __nccwpck_require__(16928);
 const slugify_1 = __importDefault(__nccwpck_require__(21396));
 /**
@@ -11205,15 +11204,37 @@ const slugify_1 = __importDefault(__nccwpck_require__(21396));
  * exact-lockfile hit (github skips the ~0.6GB download on warm runs)
  */
 const NODE_MODULES_CACHE_ID = "node-modules";
-const getYarnCache = async (context, policy = "pull-push") => {
+/**
+ * the directory whose caches this job uses. Components that are part of
+ * a shared workspace use the workspace root's caches: the install
+ * operates on the whole workspace, and the workspace build job is the
+ * one that populates the slots. Historically these component jobs
+ * (verify, docker) read a separate key family that no job ever saved,
+ * so they always started cold. Standalone components and the workspace
+ * jobs themselves keep using their own build dir (unchanged keys).
+ */
+const getCacheBaseDir = async (context) => {
+    var _a;
     const packageManagerInfo = await context.packageManagerInfo;
     const componentIsInWorkspace = context.type === "component" &&
         "componentIsInWorkspace" in packageManagerInfo &&
         packageManagerInfo.componentIsInWorkspace;
+    if (!componentIsInWorkspace)
+        return context.build.dir;
+    // the workspace build's dir when the component references one,
+    // otherwise the repo root (packageManager.ts resolves workspace
+    // membership against the root)
+    return context.build.type === "fromWorkspace"
+        ? ((_a = context.build.workspaceBuildConfig.dir) !== null && _a !== void 0 ? _a : ".")
+        : ".";
+};
+const getYarnCache = async (context, policy = "pull-push") => {
+    const baseDir = await getCacheBaseDir(context);
     return [
         {
-            scope: componentIsInWorkspace ? "global" : "buildDir",
-            pathMode: componentIsInWorkspace ? "absolute" : "relative",
+            scope: "buildDir",
+            pathMode: "relative",
+            buildDir: baseDir,
             key: "yarn",
             policy,
             paths: [".yarn"],
@@ -11230,52 +11251,28 @@ const getYarnCache = async (context, policy = "pull-push") => {
 };
 exports.getYarnCache = getYarnCache;
 const getNodeModulesCache = async (context, policy = "pull-push") => {
-    var _a, _b;
     const packageManagerInfo = await context.packageManagerInfo;
-    const componentIsInWorkspace = context.type === "component" &&
-        "componentIsInWorkspace" in packageManagerInfo &&
-        packageManagerInfo.componentIsInWorkspace;
-    const { isClassic, workspaces } = packageManagerInfo;
+    const baseDir = await getCacheBaseDir(context);
+    const { isClassic } = packageManagerInfo;
     // We intentionally do not use the contents of yarn.lock as a cache key, as yarn install should always guarantee that the files are updated, but it can still use part of the cache if not all packages are up-to-date.
     // It would slow down all pipelines whenever one adds a new dependency as it will need to download all node_modules again.
     return [
         {
             scope: "global",
             pathMode: "absolute",
-            // if component is in a shared workspace, use workspace cache. use individual cache else
-            key: componentIsInWorkspace
-                ? "node-modules-workspace"
-                : (0, slugify_1.default)(context.build.dir) + "-node-modules", // we use the dirname, not the component name, because in certain cases we have two apps in the same directory and want to share the cache, e.g. when having storybook in the same package.json
+            // we use the dirname, not the component name, because in certain cases we have two apps in the same directory and want to share the cache, e.g. when having storybook in the same package.json
+            key: (0, slugify_1.default)(baseDir) + "-node-modules",
             // content-key for immutable-cache backends (github); the lockfile
             // decides whether the cached content could have changed (absolute
-            // pathMode: resolve the standalone component's lockfile explicitly)
-            keyFiles: [
-                componentIsInWorkspace
-                    ? "yarn.lock"
-                    : (0, path_1.join)(context.build.dir, "yarn.lock"),
-            ],
+            // pathMode: resolve the lockfile explicitly)
+            keyFiles: [(0, path_1.join)(baseDir, "yarn.lock")],
             // referenced by the yarn cache: an exact hit here makes the yarn
             // zips unnecessary (see redundantOnExactHitOf on getYarnCache)
             cacheId: NODE_MODULES_CACHE_ID,
             policy,
             paths: [
-                ...(componentIsInWorkspace
-                    ? (0, lodash_es_1.uniq)([
-                        "node_modules",
-                        ...((_a = workspaces.map((w) => (0, path_1.join)(w.location, "node_modules"))) !== null && _a !== void 0 ? _a : []),
-                        ...(!isClassic
-                            ? [
-                                ".yarn/install-state.gz",
-                                ...((_b = workspaces.map((w) => (0, path_1.join)(w.location, ".yarn/install-state.gz"))) !== null && _b !== void 0 ? _b : []),
-                            ]
-                            : []),
-                    ])
-                    : [
-                        (0, path_1.join)(context.build.dir, "node_modules"),
-                        ...(!isClassic
-                            ? [(0, path_1.join)(context.build.dir, ".yarn/install-state.gz")]
-                            : []),
-                    ]),
+                (0, path_1.join)(baseDir, "node_modules"),
+                ...(!isClassic ? [(0, path_1.join)(baseDir, ".yarn/install-state.gz")] : []),
             ],
         },
     ];
@@ -13040,7 +13037,7 @@ const variables_1 = __nccwpck_require__(98885);
 exports.DEPLOY_JOB_NAME = "🚀 Deploy";
 class DeployJob extends jobs_1.CatladderJob {
     constructor(context, jobDefinition) {
-        var _a, _b, _c, _d, _e, _f;
+        var _a, _b, _c, _d, _e, _f, _g;
         const hasDocker = (0, docker_1.requiresDockerBuild)(context);
         const isStoppable = (0, utils_1.contextIsStoppable)(context);
         const autoStop = context.environment.envType === "review"
@@ -13118,6 +13115,8 @@ class DeployJob extends jobs_1.CatladderJob {
             caches: jobDefinition.cache,
             artifacts: jobDefinition.artifacts,
             services: jobDefinition.services,
+            pages: jobDefinition.pages,
+            allow_failure: (_e = jobDefinition.allow_failure) !== null && _e !== void 0 ? _e : deployConfig === null || deployConfig === void 0 ? void 0 : deployConfig.allowFailure,
             envMode: "stagePerEnv", // makes it easier to run manual tasks er env
             needs: [],
             requires: [
@@ -13137,8 +13136,8 @@ class DeployJob extends jobs_1.CatladderJob {
             },
             runnerVariables: {
                 ...variables_1.DEPLOY_RUNNER_VARIABLES,
-                ...((_e = jobDefinition.runnerVariables) !== null && _e !== void 0 ? _e : {}),
-                ...(deployConfig ? ((_f = deployConfig.runnerVariables) !== null && _f !== void 0 ? _f : {}) : {}),
+                ...((_f = jobDefinition.runnerVariables) !== null && _f !== void 0 ? _f : {}),
+                ...(deployConfig ? ((_g = deployConfig.runnerVariables) !== null && _g !== void 0 ? _g : {}) : {}),
             },
             environment: isStoppable
                 ? {
@@ -14716,6 +14715,9 @@ const createCustomDeployJobs = async (context) => {
         deploy: {
             image: (_b = deployConfig.jobImage) !== null && _b !== void 0 ? _b : (0, runner_1.getRunnerImage)("jobs-default"),
             cache: (0, getAllCacheConfigsFromConfig_1.getAllCacheConfigsFromConfig)(context, deployConfig),
+            artifacts: deployConfig.artifactsPaths
+                ? { paths: deployConfig.artifactsPaths }
+                : undefined,
             script: [
                 `cd ${context.build.dir}`,
                 ...(deployConfig.requiresYarnInstall ? yarnInstall : []),
@@ -14836,9 +14838,11 @@ const custom_1 = __nccwpck_require__(36394);
 const dockerTag_1 = __nccwpck_require__(59231);
 const kubernetes_1 = __nccwpck_require__(94469);
 const npmPackage_1 = __nccwpck_require__(79462);
+const pages_1 = __nccwpck_require__(66387);
 __exportStar(__nccwpck_require__(2691), exports);
 __exportStar(__nccwpck_require__(94469), exports);
 __exportStar(__nccwpck_require__(79462), exports);
+__exportStar(__nccwpck_require__(66387), exports);
 __exportStar(__nccwpck_require__(71446), exports);
 __exportStar(__nccwpck_require__(3537), exports);
 exports.DEPLOY_TYPES = {
@@ -14847,6 +14851,7 @@ exports.DEPLOY_TYPES = {
     dockerTag: dockerTag_1.DOCKER_TAG_DEPLOY_TYPE,
     "google-cloudrun": cloudRun_1.GCLOUD_RUN_DEPLOY_TYPE,
     npmPackage: npmPackage_1.NPM_PACKAGE_DEPLOY_TYPE,
+    pages: pages_1.PAGES_DEPLOY_TYPE,
 };
 //# sourceMappingURL=index.js.map
 
@@ -15380,10 +15385,91 @@ exports.NPM_PACKAGE_DEPLOY_TYPE = {
     jobs: deployJob_1.createNpmPackageDeployJobs,
     defaults: () => ({}),
     additionalSecretKeys: (ctx) => 
-    // publish credentials don't exist for the local env
-    ctx.envType !== "local"
-        ? [{ key: exports.NPM_TOKEN_SECRET_KEY, hidden: true }]
-        : [],
+    // publish credentials don't exist for the local env. Not hidden:
+    // the user sets the token via `catladder project secrets-set`
+    // (hidden is for machine-provisioned credentials)
+    ctx.envType !== "local" ? [{ key: exports.NPM_TOKEN_SECRET_KEY }] : [],
+    getAdditionalEnvVars: () => ({}),
+};
+//# sourceMappingURL=index.js.map
+
+/***/ }),
+
+/***/ 56173:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.createPagesDeployJobs = void 0;
+const getAllCacheConfigsFromConfig_1 = __nccwpck_require__(19034);
+const yarn_1 = __nccwpck_require__(59874);
+const runner_1 = __nccwpck_require__(71065);
+const base_1 = __nccwpck_require__(93664);
+const types_1 = __nccwpck_require__(71446);
+const createPagesDeployJobs = async (context) => {
+    var _a, _b, _c;
+    const deployConfig = (_a = context.deploy) === null || _a === void 0 ? void 0 : _a.config;
+    if (!(0, types_1.isOfDeployType)(deployConfig, "pages")) {
+        // should not happen
+        throw new Error("deploy config is not pages");
+    }
+    if (context.pipelineType === "github") {
+        // don't fail the whole github generation of a multi-backend project
+        console.warn(`component "${context.name}": the pages deploy type is not yet supported on the github backend — no deploy jobs generated`);
+        return [];
+    }
+    // review environments publish under their own path prefix (gitlab
+    // parallel deployments) — every merge request gets a site preview
+    const pathPrefix = context.environment.envType === "review" ? "mr-$CI_MERGE_REQUEST_IID" : "";
+    const publishDir = (_b = deployConfig.publishDir) !== null && _b !== void 0 ? _b : "public";
+    const yarnInstall = await (0, yarn_1.getYarnInstall)(context, {
+        noCustomPostInstall: true,
+    });
+    return (0, base_1.createDeployementJobs)(context, {
+        deploy: {
+            image: (_c = deployConfig.jobImage) !== null && _c !== void 0 ? _c : (0, runner_1.getRunnerImage)("jobs-default"),
+            cache: (0, getAllCacheConfigsFromConfig_1.getAllCacheConfigsFromConfig)(context, deployConfig),
+            artifacts: { paths: [publishDir] },
+            pages: { path_prefix: pathPrefix },
+            script: [
+                `cd ${context.build.dir}`,
+                ...(deployConfig.requiresYarnInstall ? yarnInstall : []),
+                ...deployConfig.script,
+                // the gitlab environment url should point at the published site
+                // (the base deploy job reports $ROOT_URL as environment url)
+                `export ROOT_URL="$CI_PAGES_URL${pathPrefix ? `/${pathPrefix}` : ""}"`,
+            ],
+            variables: {},
+            runnerVariables: {
+                // exposed so build scripts can adjust e.g. their base url
+                PAGES_PREFIX: pathPrefix,
+                // a pages deploy runs a full site build — the generic deploy-job
+                // resources (200Mi/400Mi) OOM on any real yarn install + build
+                KUBERNETES_MEMORY_REQUEST: "1Gi",
+                KUBERNETES_MEMORY_LIMIT: "4Gi",
+            },
+        },
+    });
+};
+exports.createPagesDeployJobs = createPagesDeployJobs;
+//# sourceMappingURL=deployJob.js.map
+
+/***/ }),
+
+/***/ 66387:
+/***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.PAGES_DEPLOY_TYPE = void 0;
+const deployJob_1 = __nccwpck_require__(56173);
+exports.PAGES_DEPLOY_TYPE = {
+    jobs: deployJob_1.createPagesDeployJobs,
+    // a broken site publish should not block the rest of the pipeline
+    defaults: () => ({ allowFailure: true }),
+    additionalSecretKeys: () => [],
     getAdditionalEnvVars: () => ({}),
 };
 //# sourceMappingURL=index.js.map
@@ -15462,6 +15548,7 @@ __exportStar(__nccwpck_require__(72025), exports);
 __exportStar(__nccwpck_require__(12152), exports);
 __exportStar(__nccwpck_require__(8030), exports);
 __exportStar(__nccwpck_require__(14571), exports);
+__exportStar(__nccwpck_require__(88510), exports);
 const isOfDeployType = (t, ...types) => {
     return t && types.includes(t.type) ? true : false;
 };
@@ -15496,6 +15583,16 @@ Object.defineProperty(exports, "__esModule", ({ value: true }));
 
 /***/ }),
 
+/***/ 88510:
+/***/ ((__unused_webpack_module, exports) => {
+
+"use strict";
+
+Object.defineProperty(exports, "__esModule", ({ value: true }));
+//# sourceMappingURL=pages.js.map
+
+/***/ }),
+
 /***/ 3537:
 /***/ ((__unused_webpack_module, exports, __nccwpck_require__) => {
 

package/dist/bundles/skills/catladder-deploys/SKILL.md

@@ -1,6 +1,6 @@
 ---
 name: catladder-deploys
-description: Configuring how a component is deployed in a catladder project — the `deploy` config in catladder.ts (deploy types kubernetes / google-cloudrun / npmPackage / dockerTag / custom, manual vs auto deploy, resources, autoscaling, health checks, CloudSQL/MongoDB, Cloud Run services/jobs/worker pools, cron jobs). Use when adding or changing a component's deploy, choosing a deploy target, setting resources/replicas/autoscaling, wiring a database, adding cron/scheduled jobs, publishing a component as an npm package, or making a deploy manual. Triggers on "deploy config", "deploy type", "kubernetes", "cloud run", "cloudrun", "autoscale", "resources", "replicas", "cloudsql", "mongodb", "cronjob", "manual deploy", "npm package", "npm publish", "publish to npm".
+description: Configuring how a component is deployed in a catladder project — the `deploy` config in catladder.ts (deploy types kubernetes / google-cloudrun / npmPackage / pages / dockerTag / custom, manual vs auto deploy, resources, autoscaling, health checks, CloudSQL/MongoDB, Cloud Run services/jobs/worker pools, cron jobs). Use when adding or changing a component's deploy, choosing a deploy target, setting resources/replicas/autoscaling, wiring a database, adding cron/scheduled jobs, publishing a component as an npm package, publishing a site on gitlab pages, or making a deploy manual. Triggers on "deploy config", "deploy type", "kubernetes", "cloud run", "cloudrun", "autoscale", "resources", "replicas", "cloudsql", "mongodb", "cronjob", "manual deploy", "npm package", "npm publish", "publish to npm", "gitlab pages", "static site", "docs site", "site preview".
 ---
 
 # Component deploys with catladder
@@ -18,7 +18,7 @@ components: {
     dir: "backend",
     build: { /* see catladder-builds */ },
     deploy: {
-      type: "kubernetes",         // kubernetes | google-cloudrun | npmPackage | dockerTag | custom
+      type: "kubernetes",         // kubernetes | google-cloudrun | npmPackage | pages | dockerTag | custom
       cluster: { type: "gcloud", name: "…", projectId: "…", region: "…" },
       values: { application: { replicas: 2 } },
     },
@@ -33,6 +33,7 @@ components: {
 | `kubernetes` | a GKE cluster via Helm | `cluster` |
 | `google-cloudrun` | Google Cloud Run | `projectId`, `region` |
 | `npmPackage` | publishes the component to an npm registry | nothing — see below |
+| `pages` | publishes a static site on gitlab pages | `script` — see below |
 | `dockerTag` | tags an image (no runtime) | `tag` — rarely used, not generally recommended |
 | `custom` | your own script | `requiresDocker`, `script` |
 
@@ -103,6 +104,34 @@ catladder secret, see `catladder-secrets`). Disable the stage
 environment as shown — a tagged release then publishes `latest`
 directly from the auto-deploying prod env.
 
+## GitLab pages sites
+
+`type: "pages"` publishes a static site (docs, storybook, coverage
+report) on gitlab pages: the deploy job runs your build `script` and
+publishes `publishDir` (default `"public"`). Review environments
+automatically publish under an `mr-<iid>` path prefix — every merge
+request gets its own site preview (the prefix is exposed to the build
+as `$PAGES_PREFIX`). The gitlab environment url points at the
+published site. GitLab-only for now.
+
+```ts
+docs: {
+  dir: "docs",
+  env: { stage: false, prod: false },  // pages exist on main + MRs
+  build: false,
+  deploy: {
+    type: "pages",
+    requiresYarnInstall: true,
+    script: ["yarn workspace docs build"],
+  },
+},
+```
+
+Pages deploys default to `allowFailure: true` (a broken site publish
+should not block the pipeline). `allowFailure` is also available on
+every other deploy type, and custom deploys can now declare
+`artifactsPaths` for output they produce.
+
 ## Full option reference
 
 See [references/deploy-types.md](references/deploy-types.md) for every

package/dist/bundles/skills/catladder-deploys/references/deploy-types.md

@@ -56,6 +56,16 @@ resources with `yarn catladder project setup`; detect drift with
 - Version/dist-tag derivation: tagged release (`prod`) → tag version under `latest`; branch/MR → `0.0.0-<branch-slug>-<sha>` under `canary` (branches `next`/`beta` publish under their own dist-tag).
 - Requires the `NPM_TOKEN` secret (managed like any catladder secret). Disable staging on the component (`env: { stage: false }`) so tagged releases publish directly.
 
+## `pages`
+
+- `type: "pages"` — **required**. Publishes a static site on gitlab pages (not yet supported on the github backend).
+- `script: string[]` — **required**; produces the site.
+- `publishDir?: string` — output directory relative to the repo root, default `"public"`.
+- `requiresYarnInstall?: boolean` — run `yarn install` first.
+- `jobImage?: GitlabJobImage`; also accepts `cache`.
+- Review envs publish under an `mr-<iid>` path prefix (parallel deployments → MR previews; exposed as `$PAGES_PREFIX`); other envs publish at the root. The environment url is the published pages url.
+- Defaults to `allowFailure: true`.
+
 ## `dockerTag`
 
 - `type: "dockerTag"`, `tag: string` — **required**. Adds a custom tag on the image repo to deploy it. Only used in one project historically; not generally recommended (runtime env vars must be coordinated manually).