@catladder/pipeline 3.6.0 → 3.8.0

package/examples/cloud-run-health-check-defaults.ts

@@ -0,0 +1,28 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+        service: {
+          healthCheck: true,
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Health Check",
+};

package/examples/cloud-run-health-check-only-startup.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-health-check-only-startup";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-health-check-only-startup local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/examples/cloud-run-health-check-only-startup.ts

@@ -0,0 +1,38 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+        service: {
+          healthCheck: {
+            livenessProbe: false,
+            startupProbe: {
+              type: "http1",
+              failureThreshold: 43,
+              initialDelaySeconds: 4,
+              path: "/something2",
+              periodSeconds: 5,
+              timeoutSeconds: 6,
+            },
+          },
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Health Check",
+};

package/examples/cloud-run-health-check.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-health-check";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-health-check local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/examples/cloud-run-health-check.ts

@@ -0,0 +1,45 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+        service: {
+          healthCheck: {
+            livenessProbe: {
+              type: "http1",
+              failureThreshold: 42,
+              initialDelaySeconds: 1,
+              path: "/something",
+              periodSeconds: 2,
+              timeoutSeconds: 3,
+            },
+            startupProbe: {
+              type: "http1",
+              failureThreshold: 43,
+              initialDelaySeconds: 4,
+              path: "/something2",
+              periodSeconds: 5,
+              timeoutSeconds: 6,
+            },
+          },
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: Health Check",
+};

package/examples/cloud-run-llama.test.ts

@@ -0,0 +1,11 @@
+import { createYamlLocalPipeline } from "./__utils__/helpers";
+import config from "./cloud-run-llama";
+
+/**
+ * This test is auto-generated.
+ * Modifications will be overwritten on every `yarn test` run!
+ */
+
+it("matches snapshot for cloud-run-llama local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/examples/cloud-run-llama.ts

@@ -0,0 +1,40 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "my-ai-app",
+  customerName: "pan",
+  components: {
+    llm: {
+      dir: "llm",
+      build: false,
+      vars: {
+        secret: ["HF_TOKEN"],
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west4", // verify in which regions GPUs are available, europe-west6 is not supported as of time of writing
+        service: {
+          image:
+            "us-docker.pkg.dev/deeplearning-platform-release/gcr.io/huggingface-text-generation-inference-cu124.2-3.ubuntu2204.py311",
+          args: [
+            "--model-id=meta-llama/Llama-3.2-1B-Instruct",
+            "--max-concurrent-requests=1",
+          ],
+          cpu: 8,
+
+          noCpuThrottling: true, // must be set to true for GPUs
+          gpu: 1,
+          gpuType: "nvidia-l4",
+          memory: "32Gi",
+        },
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: llama example",
+};

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "3.6.0",
+  "version": "3.8.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables",

package/src/build/artifacts/createBuildJobArtifact.ts

@@ -41,7 +41,9 @@ const getArtifactsPathForComponent = (
   additionalPaths?: string[],
 ): string[] => {
   return [
-    ...(c.build.config.artifactsPaths ?? []),
+    ...(c.build.type !== "disabled"
+      ? (c.build.config.artifactsPaths ?? [])
+      : []),
     ...(additionalPaths ?? []),
   ]?.flatMap((artifact) =>
     c.build

package/src/build/base/index.ts

@@ -1,5 +1,8 @@
 import { sbomDeactivated } from "../../deploy/sbom";
-import type { WorkspaceContext } from "../../types/context";
+import type {
+  ComponentContextWithBuild,
+  WorkspaceContext,
+} from "../../types/context";
 import {
   componentContextHasWorkspaceBuild,
   componentContextIsStandaloneBuild,
@@ -16,7 +19,7 @@ import { APP_BUILD_JOB_NAME } from "./constants";
 import { createAppBuildJob } from "./createAppBuildJob";
 
 export const createComponentBuildJobs = (
-  context: ComponentContext,
+  context: ComponentContextWithBuild,
   definitions: {
     appBuild?: AppBuildJobDefinition;
     dockerBuild: DockerBuildJobDefinition;

package/src/build/cache/getAllCacheConfigsFromConfig.ts

@@ -16,12 +16,13 @@ export const getAllCacheConfigsFromConfig = (
       ? // also add cache configs of the components of that workspace
         // FIXNME: this only works currently for the build config
         // we would probably need to introduce a path to the right config property (build-->test or so)
-        context.components.flatMap<CacheConfig>(
-          (componentContext) =>
-            ensureArray(componentContext.build.config.cache).map((c) => ({
-              ...c,
-              baseDir: componentContext.build.dir,
-            })) ?? [],
+        context.components.flatMap<CacheConfig>((componentContext) =>
+          componentContext.build.type !== "disabled"
+            ? (ensureArray(componentContext.build.config.cache).map((c) => ({
+                ...c,
+                baseDir: componentContext.build.dir,
+              })) ?? [])
+            : [],
         )
       : []),
   ];

package/src/build/custom/buildJob.ts

@@ -1,4 +1,4 @@
-import type { ComponentContext } from "../../types/context";
+import type { ComponentContextWithBuild } from "../../types/context";
 import { getDockerBuildScriptWithBuiltInDockerFile } from "../docker";
 import { isOfBuildType } from "../types";
 
@@ -7,7 +7,7 @@ import { createComponentBuildJobs } from "../base";
 import { createBuildJobDefinition } from "../base/createBuildJobDefinition";
 
 export const createCustomBuildJobs = (
-  context: ComponentContext,
+  context: ComponentContextWithBuild,
 ): CatladderJob[] => {
   const buildConfig = context.build.config;
 

package/src/build/custom/index.ts

@@ -1,8 +1,10 @@
-import type { ComponentContext } from "../../types/context";
+import type { ComponentContextWithBuild } from "../../types";
 import type { CatladderJob } from "../../types/jobs";
 import { createCustomBuildJobs } from "./buildJob";
 import { createCustomTestJobs } from "./testJob";
 
-export const createCustomJobs = (context: ComponentContext): CatladderJob[] => {
+export const createCustomJobs = (
+  context: ComponentContextWithBuild,
+): CatladderJob[] => {
   return [...createCustomTestJobs(context), ...createCustomBuildJobs(context)];
 };

package/src/build/custom/testJob.ts

@@ -1,5 +1,5 @@
 import type { Artifacts } from "../../types";
-import type { ComponentContext } from "../../types/context";
+import type { ComponentContextWithBuild } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import { ensureArray, notNil } from "../../utils";
 import { createArtifactsConfig } from "../base/createArtifactsConfig";
@@ -13,7 +13,7 @@ const RUNNER_CUSTOM_TEST_VARIABLES = {
 };
 
 export const createCustomTestJobs = (
-  context: ComponentContext,
+  context: ComponentContextWithBuild,
 ): CatladderJob[] => {
   // don't run tests after release
   // TODO: this will be replaced by using rules

package/src/build/docker.ts

@@ -10,7 +10,11 @@ import {
 } from "../deploy/cloudRun/artifactsRegistry";
 import { gcloudServiceAccountLoginCommands } from "../deploy/cloudRun/utils/gcloudServiceAccountLoginCommands";
 import { getRunnerImage } from "../runner";
-import type { ComponentContext, DockerBuildJobDefinition } from "../types";
+import type {
+  ComponentContext,
+  ComponentContextWithBuild,
+  DockerBuildJobDefinition,
+} from "../types";
 import type { CatladderJob } from "../types/jobs";
 import { collapseableSection } from "../utils/gitlab";
 import { createJobCacheFromCacheConfigs } from "./cache/createJobCache";
@@ -84,7 +88,7 @@ const getDockerAdditions = (build: BuildConfig) => {
         : undefined,
   };
 };
-export const getDockerBuildVariables = (context: ComponentContext) => {
+export const getDockerBuildVariables = (context: ComponentContextWithBuild) => {
   return {
     ...getDockerAdditions(context.build.config),
     APP_DIR: context.build.dir,
@@ -120,7 +124,7 @@ export const getDockerJobBaseProps = (): Pick<
 };
 
 export const createDockerBuildJobBase = (
-  context: ComponentContext,
+  context: ComponentContextWithBuild,
   { script, cache, ...def }: DockerBuildJobDefinition,
 ): CatladderJob => {
   return merge(
@@ -163,7 +167,7 @@ const BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS = {
 };
 
 export const getDockerBuildScriptWithBuiltInDockerFile = (
-  context: ComponentContext,
+  context: ComponentContextWithBuild,
   defaultType?: BuildConfigDocker["type"],
 ) => {
   const type =

package/src/build/index.ts

@@ -1,4 +1,7 @@
-import type { ComponentContext, WorkspaceContext } from "../types/context";
+import type {
+  ComponentContextWithBuild,
+  WorkspaceContext,
+} from "../types/context";
 import type { EnvironmentContext } from "../types/environmentContext";
 
 import type { CatladderJob } from "../types/jobs";
@@ -16,7 +19,7 @@ export * from "./types";
 
 export type BuildTypes = {
   [type in BuildConfigStandaloneType]: {
-    jobs: (context: ComponentContext) => CatladderJob[];
+    jobs: (context: ComponentContextWithBuild) => CatladderJob[];
     defaults: (
       envContext: EnvironmentContext,
     ) => Partial<Extract<BuildConfig, { type: type }>>;

package/src/build/node/buildJob.ts

@@ -1,5 +1,6 @@
 import type {
   BuildContextStandalone,
+  ComponentContextWithBuild,
   WorkspaceContext,
 } from "../../types/context";
 import {
@@ -19,7 +20,7 @@ import { getNodeCache, getYarnCache } from "./cache";
 import { getDockerAppCopyAndBuildScript, getYarnInstall } from "./yarn";
 
 export const createNodeBuildJobs = (
-  context: ComponentContext | WorkspaceContext,
+  context: ComponentContextWithBuild | WorkspaceContext,
 ): CatladderJob[] => {
   if (context.type === "workspace") {
     return createWorkspaceBuildJobs(context, {
@@ -47,8 +48,10 @@ export const createNodeBuildJobDefinition = (
   });
 };
 
+type NewType = ComponentContextWithBuild;
+
 export const createNodeDockerJobDefinition = (
-  context: ComponentContext,
+  context: NewType,
 ): DockerBuildJobDefinition => {
   // get the default docker built-in type based on the build type
   const dockerDefaultBuiltIn: BuildConfigDocker["type"] =

package/src/build/node/index.ts

@@ -1,21 +1,26 @@
-import type { ComponentContext, WorkspaceContext } from "../../types/context";
+import type {
+  ComponentContextWithBuild,
+  WorkspaceContext,
+} from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
 import { createNodeBuildJobs } from "./buildJob";
 import { createMeteorBuildJobs } from "./meteor";
 import { createNodeTestJobs } from "./testJob";
 
 export const createNodeJobs = (
-  context: ComponentContext | WorkspaceContext,
+  context: ComponentContextWithBuild | WorkspaceContext,
 ): CatladderJob[] => {
   return [...createNodeTestJobs(context), ...createNodeBuildJobs(context)];
 };
 
 export const createStorybookJobs = (
-  context: ComponentContext,
+  context: ComponentContextWithBuild,
 ): CatladderJob[] => {
   return [...createNodeBuildJobs(context)];
 };
 
-export const createMeteorJobs = (context: ComponentContext): CatladderJob[] => {
+export const createMeteorJobs = (
+  context: ComponentContextWithBuild,
+): CatladderJob[] => {
   return [...createNodeTestJobs(context), ...createMeteorBuildJobs(context)];
 };

package/src/build/node/meteor.ts

@@ -1,5 +1,8 @@
 import { getRunnerImage } from "../../runner";
-import type { ComponentContext } from "../../types/context";
+import type {
+  ComponentContext,
+  ComponentContextWithBuild,
+} from "../../types/context";
 
 import type { CatladderJob } from "../../types/jobs";
 
@@ -23,7 +26,7 @@ const getMeteorCache = (context: ComponentContext): CacheConfig[] => [
   },
 ];
 export const createMeteorBuildJobs = (
-  context: ComponentContext,
+  context: ComponentContextWithBuild,
 ): CatladderJob[] => {
   const buildConfig = context.build.config;
 

package/src/build/node/yarn.ts

@@ -1,5 +1,5 @@
 import { BashExpression } from "../../bash/BashExpression";
-import type { Context } from "../../types";
+import { type Context } from "../../types";
 import { ensureArray } from "../../utils";
 import { collapseableSection } from "../../utils/gitlab";
 
@@ -32,7 +32,9 @@ export const getYarnInstall = (
   },
 ) => {
   const postInstall =
-    context.type !== "workspace" && "postInstall" in context.build.config
+    context.type !== "workspace" &&
+    context.build.type !== "disabled" &&
+    "postInstall" in context.build.config
       ? context.build.config.postInstall
       : null;
   return [

package/src/build/rails/build.ts

@@ -1,9 +1,5 @@
-import {
-  componentContextIsStandaloneBuild,
-  type BuildConfigRails,
-  type BuildContextStandalone,
-  type ComponentContext,
-} from "../..";
+import type { ComponentContextWithBuild } from "../..";
+import { componentContextIsStandaloneBuild } from "../..";
 import type { CatladderJob } from "../../types/jobs";
 import { createComponentBuildJobs } from "../base";
 import {
@@ -14,7 +10,7 @@ import {
 import { isOfBuildType } from "../types";
 
 export const createRailsBuildJobs = (
-  context: ComponentContext,
+  context: ComponentContextWithBuild,
 ): CatladderJob[] => {
   const buildConfig = context.build.config;
   if (!isOfBuildType(buildConfig, "rails")) {

package/src/build/rails/index.ts

@@ -1,8 +1,10 @@
-import type { ComponentContext } from "../../types";
+import type { ComponentContextWithBuild } from "../../types";
 import type { CatladderJob } from "../../types/jobs";
 import { createRailsBuildJobs } from "./build";
 import { createRailsTestJobs } from "./test";
 
-export const createRailsJobs = (context: ComponentContext): CatladderJob[] => {
+export const createRailsJobs = (
+  context: ComponentContextWithBuild,
+): CatladderJob[] => {
   return [...createRailsTestJobs(context), ...createRailsBuildJobs(context)];
 };

package/src/build/sbom.ts

@@ -1,12 +1,14 @@
 import { isStandaloneBuildConfig } from ".";
-import type { ComponentContext } from "../types/context";
+import type { ComponentContextWithBuild } from "../types/context";
 import type { CatladderJob } from "../types/jobs";
 import { ensureArrayOrNull } from "../utils";
 
 export const SBOM_BUILD_JOB_NAME = "🧾 sbom";
 export const SBOM_FILE = "__sbom.json";
 
-export const createSbomBuildJob = (context: ComponentContext): CatladderJob => {
+export const createSbomBuildJob = (
+  context: ComponentContextWithBuild,
+): CatladderJob => {
   const buildConfig = context.build.config;
 
   const defaultImage = "aquasec/trivy:0.38.3";

package/src/context/createComponentContext.ts

@@ -42,26 +42,31 @@ export const createComponentContext = async (
 
   const componentConfigWithoutDefaults = envContext.envConfigRaw;
 
-  const resolvedBuildType = isStandaloneBuildConfig(
-    componentConfigWithoutDefaults.build,
-  )
-    ? componentConfigWithoutDefaults.build.type
-    : ctx.config.builds?.[componentConfigWithoutDefaults.build.from].type;
-  if (!resolvedBuildType) {
+  const resolvedBuildType =
+    componentConfigWithoutDefaults.build === false
+      ? false
+      : isStandaloneBuildConfig(componentConfigWithoutDefaults.build)
+        ? componentConfigWithoutDefaults.build.type
+        : ctx.config.builds?.[componentConfigWithoutDefaults.build.from].type;
+  if (resolvedBuildType === undefined) {
     throw new Error("build type not found, is the build config correct?");
   }
   const defaults: {
-    build: PartialDeep<BuildConfig>;
+    build: PartialDeep<BuildConfig | false>;
     deploy: PartialDeep<DeployConfig>;
   } = componentConfigWithoutDefaults.deploy
     ? {
-        build: BUILD_TYPES[resolvedBuildType].defaults(envContext),
+        build:
+          resolvedBuildType &&
+          BUILD_TYPES[resolvedBuildType].defaults(envContext),
         deploy: DEPLOY_TYPES[
           componentConfigWithoutDefaults.deploy.type as DeployConfigType
         ].defaults(envContext as any),
       }
     : {
-        build: BUILD_TYPES[resolvedBuildType].defaults(envContext),
+        build:
+          resolvedBuildType &&
+          BUILD_TYPES[resolvedBuildType].defaults(envContext),
         deploy: {},
       };
 
@@ -80,6 +85,14 @@ export const createComponentContext = async (
       : []),
   ];
   const _getBuildContext = (): BuildContextComponent => {
+    if (build === false) {
+      return {
+        type: "disabled",
+        getComponentDirs,
+        dir,
+      };
+    }
+
     if (isStandaloneBuildConfig(build)) {
       return {
         dir: dir,

package/src/context/getLabels.ts

@@ -14,7 +14,10 @@ export const getLabels = (context: ComponentContext) => {
     "app-name": sanitize(context.fullConfig.appName),
     "env-type": sanitize(context.environment.envType),
     "env-name": sanitize(context.env),
-    "build-type": sanitize(context.build.buildType),
+    "build-type":
+      context.build.type === "disabled"
+        ? "disabled"
+        : sanitize(context.build.buildType),
     ...(context.fullConfig.meta?.labels ?? {}),
   };
   return labels;

package/src/deploy/cloudRun/createJobs/cloudRunJobs.ts

@@ -14,7 +14,7 @@ import {
 } from "./common";
 import { ENV_VARS_FILENAME } from "./constants";
 import { createVolumeConfig } from "./volumes";
-import { getCloudRunJobArgsArg } from "./execute/onDeploy";
+import { getCloudRunServiceOrJobArgsArg } from "../utils/getJobOrServiceArgs";
 
 export const getDeleteJobsScripts = (context: ComponentContext) => {
   const commonArgs = getCommonCloudRunArgs(context);
@@ -44,7 +44,7 @@ export const getJobCreateScripts = (context: ComponentContext): string[] =>
       const commonDeployArgsString = createArgsString(
         {
           command: `"${commandArray.join(",")}"`,
-          args: getCloudRunJobArgsArg(job.args),
+          args: getCloudRunServiceOrJobArgsArg(job.args),
           labels: `"${makeLabelString(getLabels(context))},cloud-run-job-name=$current_job_name"`,
           image: `"${job.image ?? commonImage}"`,
           project,

package/src/deploy/cloudRun/createJobs/cloudRunServices.ts

@@ -3,6 +3,7 @@ import type { ComponentContext } from "../../../types/context";
 
 import type { DeployConfigCloudRunService } from "../../types/googleCloudRun";
 import { createArgsString } from "../utils/createArgsString";
+import { getCloudRunServiceOrJobArgsArg } from "../utils/getJobOrServiceArgs";
 import { getServiceName } from "../utils/getServiceName";
 import {
   gcloudRunCmd,
@@ -11,6 +12,7 @@ import {
   makeLabelString,
 } from "./common";
 import { ENV_VARS_FILENAME } from "./constants";
+import { healthCheckCliArgs } from "./healthCheck";
 import { createVolumeConfig } from "./volumes";
 
 export const getServiceDeployScript = (
@@ -25,7 +27,10 @@ export const getServiceDeployScript = (
   const customConfig = service !== true ? service : undefined;
   const command =
     service !== true
-      ? (service?.command ?? context.build.config.startCommand)
+      ? (service?.command ??
+        (context.build.type !== "disabled"
+          ? context.build.config.startCommand
+          : undefined))
       : undefined;
 
   const commandArray = command
@@ -34,11 +39,14 @@ export const getServiceDeployScript = (
       : command.split(" ")
     : undefined;
   const fullServiceName = serviceName.concat(nameSuffix ?? "");
+
   const argsString = createArgsString(
     {
       // command as empty string resets it to default (uses the image's entrypoint)
       command: commandArray ? '"' + commandArray.join(",") + '"' : '""',
+      args: getCloudRunServiceOrJobArgsArg(customConfig?.args),
       ...commonDeployArgs,
+      image: customConfig?.image ?? commonDeployArgs.image,
       labels: makeLabelString({
         ...getLabels(context),
         "cloud-run-service-name": fullServiceName,
@@ -61,6 +69,7 @@ export const getServiceDeployScript = (
       "execution-environment": customConfig?.executionEnvironment,
       gpu: customConfig?.gpu,
       "gpu-type": customConfig?.gpuType,
+      ...healthCheckCliArgs(customConfig?.healthCheck),
     },
     ...createVolumeConfig(customConfig?.volumes, "service"),
   );
@@ -97,5 +106,8 @@ const requiresBeta = (config: DeployConfigCloudRunService | undefined) => {
   if (config.gpu && config.gpu > 0) {
     return true;
   }
+  if (config.healthCheck !== undefined) {
+    return true;
+  }
   return false;
 };