@catladder/pipeline 2.10.0 → 2.10.2

package/examples/override-secrets.test.ts

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

package/examples/override-secrets.ts

@@ -0,0 +1,40 @@
+import type { Config } from "../src";
+
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    ["my-app"]: {
+      dir: "app",
+      build: {
+        type: "node",
+      },
+      vars: {
+        secret: ["MY_SECRET"],
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "my-project-id",
+        region: "europe-west6",
+      },
+      env: {
+        local: {
+          vars: {
+            secret: ["MY_LOCAL_SECRET"],
+          },
+        },
+        review: {
+          vars: {
+            secret: ["MY_REVIEW_SECRET"],
+          },
+        },
+      },
+    },
+  },
+};
+
+export default config;
+
+export const information = {
+  title: "Multiline Environment Variables",
+};

package/package.json

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

package/src/bash/bashEscape.ts

@@ -57,6 +57,9 @@ export const escapeDoubleQuotes = (value: string | null | undefined) =>
 export const escapeSingleQuotes = (value: string | null | undefined) =>
   value?.toString().replace(/'/g, "\\'");
 
+export type EscapeForDotEnvOptions = {
+  quoteMode: "auto" | "always";
+};
 /**
  *
  * escape env vars for .env files.
@@ -75,6 +78,9 @@ export const escapeSingleQuotes = (value: string | null | undefined) =>
  */
 export const escapeForDotEnv = (
   value: VariableValue | undefined | null,
+  options: EscapeForDotEnvOptions = {
+    quoteMode: "auto",
+  },
 ): string => {
   if (value === undefined || value === null) {
     return "";
@@ -82,7 +88,7 @@ export const escapeForDotEnv = (
   if (typeof value === "string") {
     // if string contains newlines, we need to wrap it in quotes
     // we additionaly escape newlines, that give best compatibility
-    if (value.includes("\n")) {
+    if (options.quoteMode === "always" || value.includes("\n")) {
       const newlinesReplaces = value.replace(/\n/g, "\\n");
 
       // default to ", but if this is not possible, we try to use ' or `