@catladder/pipeline 1.77.1 → 1.78.0

package/examples/kubernetes-with-jobs.ts

@@ -0,0 +1,68 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "kubernetes",
+        cluster: {
+          name: "some-cluster-name",
+          region: "europe-west6",
+          projectId: "some-project-id",
+          type: "gcloud",
+          domainCanonical: "panter.cloud",
+        },
+        values: {
+          jobs: {
+            migration: {
+              command: "yarn migrate",
+            },
+          },
+          cronjobs: {
+            ["send-emails"]: {
+              command: "yarn send emails",
+              schedule: "0 * * * *",
+            },
+          },
+        },
+      },
+      env: {
+        review: {
+          deploy: {
+            values: {
+              cronjobs: {
+                ["send-emails"]: false,
+              },
+            },
+          },
+        },
+      },
+    },
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "kubernetes",
+        cluster: {
+          name: "some-cluster-name",
+          region: "europe-west6",
+          projectId: "some-project-id",
+          type: "gcloud",
+          domainCanonical: "panter.cloud",
+        },
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@catladder/pipeline",
-  "version": "1.77.1",
+  "version": "1.78.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/src/deploy/kubernetes/kubeValues.ts

@@ -44,6 +44,13 @@ const createAppConfig = (
   );
 };
 
+const removeFalsy = <T>(record?: Record<string, false | T>) => {
+  if (!record) return undefined;
+  return Object.fromEntries(
+    Object.entries(record).filter(([, value]) => value !== false)
+  );
+};
+
 export const createKubeValues = (context: Context) => {
   const deployConfig = context.componentConfig.deploy;
   if (deployConfig === false) {
@@ -59,7 +66,7 @@ export const createKubeValues = (context: Context) => {
   // we remove the application config because it can be just the value `false` which is a convenience feature, but not supported in the helm chart
   // we only merge the rest of the values in
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
-  const { application, ...rest } = values ?? {};
+  const { application, jobs, cronjobs, ...rest } = values ?? {};
 
   const env = createKubeEnv(context);
 
@@ -75,7 +82,12 @@ export const createKubeValues = (context: Context) => {
   );
 
   const kubeValues = processSecretsAsFiles(
-    mergeWithMergingArrays(defaultKubeValues, rest)
+    mergeWithMergingArrays(defaultKubeValues, {
+      jobs: removeFalsy(jobs),
+      cronjobs: removeFalsy(cronjobs),
+
+      ...rest,
+    })
   );
 
   return kubeValues;

package/src/deploy/types/kubernetes.ts

@@ -160,29 +160,31 @@ export type DeployConfigKubernetesValues = AllowUnknownProps<{
    */
   jobs?: Record<
     string,
-    AllowUnknownProps<{
-      /**
-       * the command to execute
-       */
-      command: string;
-      /**
-       * comma-separated list of helm hooks, see https://helm.sh/docs/topics/charts_hooks/
-       *
-       * defaults to post-install,post-upgrade
-       */
-      hook?: string;
-    }>
+    | false
+    | AllowUnknownProps<{
+        /**
+         * the command to execute
+         */
+        command: string;
+        /**
+         * comma-separated list of helm hooks, see https://helm.sh/docs/topics/charts_hooks/
+         *
+         * defaults to post-install,post-upgrade
+         */
+        hook?: string;
+      }>
   >;
   /**
    * cronjobs that run periodically. These use the app image have all env vars available.
    */
   cronjobs?: Record<
     string,
-    AllowUnknownProps<{
-      schedule: string;
-      command: string;
-      concurrencyPolicy?: "Forbid" | "Allow" | "Replace";
-    }>
+    | false
+    | AllowUnknownProps<{
+        schedule: string;
+        command: string;
+        concurrencyPolicy?: "Forbid" | "Allow" | "Replace";
+      }>
   >;
   /**
    * configuration for the application ("Deployment" in kubernetes)