@catladder/pipeline 1.89.4 → 1.90.0

package/examples/custom-deploy.ts

@@ -0,0 +1,25 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "custom",
+        requiresDocker: true,
+        script: ["echo 'would deploy'"],
+        stopScript: ["echo 'would stop'"],
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/package.json

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

package/src/context/getEnvironmentVariables.ts

@@ -9,6 +9,11 @@ import {
   translateLegacyFromComponents,
 } from "./resolveReferences";
 
+export type SecretEnvVar = {
+  key: string;
+  // hidden env vars are not shown in config-secrets
+  hidden?: boolean;
+};
 export const getEnvironmentVariables = async (
   config: Config,
   componentName: string,
@@ -17,7 +22,7 @@ export const getEnvironmentVariables = async (
   alreadyVisited: Record<string, Record<string, boolean>> = {} // to prevent endless loop
 ): Promise<{
   envVars: Record<string, string>;
-  secretEnvVarKeys: string[];
+  secretEnvVarKeys: SecretEnvVar[];
   host: string;
   url: string;
 }> => {
@@ -81,12 +86,12 @@ export const getEnvironmentVariables = async (
       )
     : [];
 
-  const secretEnvVarKeys = [
-    ...(envConfigRaw.vars?.secret ?? []),
+  const secretEnvVarKeys: SecretEnvVar[] = [
+    ...(envConfigRaw.vars?.secret ?? []).map((key) => ({ key })),
     ...additionalSecretKeys,
   ];
   const secretEnvVars = Object.fromEntries(
-    secretEnvVarKeys.map((key) => [
+    secretEnvVarKeys.map(({ key }) => [
       key,
       `$${getSecretVarName(env, componentName, key)}`,
     ])

package/src/deploy/cloudRun/deployJob.ts

@@ -1,5 +1,5 @@
 import { dump } from "js-yaml";
-import { isNil, merge, omit } from "lodash";
+import { merge, omit } from "lodash";
 import { GCLOUD_DEPLOY_CREDENTIALS_KEY } from ".";
 import { getDockerJobBaseProps, gitlabDockerLogin } from "../../build/docker";
 import { getLabels } from "../../context/getLabels";

package/src/deploy/cloudRun/index.ts

@@ -58,9 +58,16 @@ export const GCLOUD_RUN_DEPLOY_TYPE: DeployTypeDefinition<"google-cloudrun"> = {
     return {};
   },
   additionalSecretKeys: (ctx) => [
-    GCLOUD_DEPLOY_CREDENTIALS_KEY,
+    {
+      key: GCLOUD_DEPLOY_CREDENTIALS_KEY,
+      hidden: true,
+    },
+    {
+      key: GCLOUD_RUN_CANONICAL_HOST_SUFFIX,
+      hidden: true,
+    },
     ...(ctx.deployConfigRaw && ctx.deployConfigRaw.cloudSql
-      ? ["DB_PASSWORD"]
+      ? [{ key: "DB_PASSWORD" }]
       : []),
   ],
   getAdditionalEnvVars: (ctx) => {

package/src/deploy/custom/deployJob.ts

@@ -4,7 +4,7 @@ import { getYarnInstall } from "../../build/node/yarn";
 import { getRunnerImage } from "../../runner";
 import type { Context } from "../../types/context";
 import type { CatladderJob } from "../../types/jobs";
-import { getBaseDeploymentJob } from "../base";
+import { getBaseDeploymentJob, getBaseDeploymentStopJob } from "../base";
 import { isOfDeployType } from "../types";
 
 export const createCustomDeployJobs = (context: Context): CatladderJob[] => {
@@ -29,5 +29,13 @@ export const createCustomDeployJobs = (context: Context): CatladderJob[] => {
         ...deployConfig.script,
       ],
     }),
+    ...(deployConfig.stopScript
+      ? [
+          merge({}, getBaseDeploymentStopJob(context), {
+            image: deployConfig.jobImage ?? getRunnerImage("jobs-default"),
+            script: deployConfig.stopScript,
+          }),
+        ]
+      : []),
   ];
 };

package/src/deploy/index.ts

@@ -1,3 +1,4 @@
+import type { SecretEnvVar } from "..";
 import type { Context } from "../types/context";
 import type { EnvironmentContext } from "../types/environmentContext";
 import type { CatladderJob } from "../types/jobs";
@@ -17,7 +18,9 @@ export type DeployTypeDefinition<T extends DeployConfigType> = {
   defaults: (
     envContext: EnvironmentContext<any, T>
   ) => PartialDeep<DeployConfigGeneric<T>>;
-  additionalSecretKeys: (envContext: EnvironmentContext<any, T>) => string[];
+  additionalSecretKeys: (
+    envContext: EnvironmentContext<any, T>
+  ) => SecretEnvVar[];
   getAdditionalEnvVars: (
     envContext: EnvironmentContext<any, T>
   ) => Record<string, string | undefined | null>;

package/src/deploy/kubernetes/additionalSecretKeys.ts

@@ -19,5 +19,5 @@ export const additionalKubernetesSecretKeys = ({
     keys.push("cloudsqlProxyCredentials");
   }
 
-  return keys;
+  return keys.map((key) => ({ key }));
 };

package/src/types/context.ts

@@ -1,3 +1,4 @@
+import type { SecretEnvVar } from "../context";
 import type {
   PipelineTrigger,
   ComponentConfig,
@@ -25,7 +26,7 @@ export type Environment = {
    */
   envVars: Record<string, string>;
   envType: EnvType;
-  secretEnvVarKeys: string[];
+  secretEnvVarKeys: SecretEnvVar[];
 };
 
 export type CommitInfo = {