@catladder/pipeline 1.148.0 → 1.149.0

package/src/pipeline/__tests__/getPipelineStages.test.ts

@@ -0,0 +1,63 @@
+import { type DeployConfigKubernetesCluster } from "../..";
+import type { Config } from "../../types";
+import { getPipelineStages } from "../getPipelineStages";
+
+describe("getPipelineStages()", () => {
+  const cluster: DeployConfigKubernetesCluster = {
+    type: "gcloud",
+    name: "mega-cluster",
+    projectId: "super-google-project",
+    region: "ch-blabla",
+  };
+  const SIMPLE_CONFIG1: Config = {
+    appName: "my-app",
+    customerName: "pan",
+    components: {
+      app1: {
+        dir: "dir1",
+        build: {
+          type: "node",
+        },
+        deploy: { type: "kubernetes", cluster },
+      },
+      app2: {
+        dir: "dir2",
+        build: {
+          type: "node",
+        },
+        deploy: { type: "kubernetes", cluster },
+        env: {
+          dev2: {
+            type: "dev",
+          },
+          review2: {
+            type: "review",
+          },
+          stage2: {
+            type: "stage",
+          },
+          prod2: {
+            type: "prod",
+          },
+        },
+      },
+      app3: {
+        dir: "dir2",
+        build: {
+          type: "node",
+        },
+        deploy: { type: "kubernetes", cluster },
+        env: {
+          dev: false,
+          review: false,
+          stage: false,
+          prod: false,
+        },
+      },
+    },
+  };
+
+  it("should return all envs for SIMPLE_CONFIG1", () => {
+    expect(getPipelineStages(SIMPLE_CONFIG1)).toMatchSnapshot();
+  });
+});

package/src/pipeline/getPipelineStages.ts

@@ -3,13 +3,14 @@ import type { Config } from "../types/config";
 import { BASE_STAGES } from "../types/jobs";
 
 /**
- * 
-  while technically not required, we group different envs in its own stage
-  each job from `createJobs` that is defined as `envMode: "stagePerEnv"` will have `deploy dev`, etc. instead of just `deploy`
-  this is just so that it looks nicer in gitlab and makes running mutliple manual tasks more easy to use
+ * while technically not required, we group different envs in its own stage
+ * each job from `createJobs` that is defined as `envMode: "stagePerEnv"` will have `deploy dev`, etc. instead of just `deploy`
+ * this is just so that it looks nicer in gitlab and makes running mutliple manual tasks more easy to use
  */
 export function getPipelineStages(config: Config) {
-  const allEnvs = getAllEnvsInAllComponents(config);
+  const allEnvs = getAllEnvsInAllComponents(config).filter(
+    (e) => e !== "local",
+  );
   const stages = BASE_STAGES.reduce<string[]>(
     (acc, baseStage) => [
       ...acc,

package/src/utils/writeFiles.ts

@@ -33,8 +33,21 @@ export const writeGeneratedFile = async (
   );
 };
 
+type StringifyOptions = Exclude<
+  Parameters<typeof stringify>[2],
+  null | undefined | string | number
+>;
+export const yamlStringifyOptions: StringifyOptions = {
+  // prevents colapsing long command statements into multiple lines
+  lineWidth: 0,
+  // represent multi line commands as single line json strings
+  doubleQuotedAsJSON: true,
+  // Better readability when bash commands most often use double quotes
+  singleQuote: true,
+};
+
 export const writeYamlfile = async (path: string, data: any) => {
-  await writeGeneratedFile(path, stringify(data), {
+  await writeGeneratedFile(path, stringify(data, yamlStringifyOptions), {
     commentChar: "#",
   });
 };