@catladder/pipeline 1.138.0 → 1.139.0

package/examples/local-dot-env.ts

@@ -0,0 +1,25 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    api: {
+      dotEnv: "local", // creates .env file only locally, not during build
+      envDTs: true, // creates type files based on env vars, so that process.env is typed
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/package.json

@@ -52,7 +52,7 @@
     }
   ],
   "license": "MIT",
-  "version": "1.138.0",
+  "version": "1.139.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/src/build/base/createAppBuildJob.ts

@@ -34,7 +34,9 @@ export const createAppBuildJob = (
       },
 
       script: [
-        ...(context.componentConfig.dotEnv ? writeDotEnv(context) : []),
+        ...(context.componentConfig.dotEnv === true // don't build when set to `local`
+          ? writeDotEnv(context)
+          : []),
         ...writeBuildInfo(context),
         ...ensureNodeVersion(context), // in pure node repos, we might want to have the nvmrc file in top-level
         `cd ${context.componentConfig.dir}`,

package/src/types/config.ts

@@ -4,6 +4,7 @@ import type { DeployConfig } from "../deploy/types";
 import type { CatladderJob } from "./jobs";
 import type { Context } from "./context";
 import type { PartialDeep } from "./utils";
+import { load } from "js-yaml";
 export type PipelineTrigger = "mainBranch" | "mr" | "taggedRelease";
 
 /**
@@ -146,13 +147,23 @@ export type ComponentConfig<C extends ConfigProps = never> = {
   customJobs?: CatladderJob[] | ((context: Context) => CatladderJob[]);
 
   /**
-   * experimental. whether to create a .env localy and during build jobs
+   * whether to create a .env
    *
    * Be careful, this will overwrite any existing .env file!
+   *
+   * if set to true it will create .env locally and during build.
+   * Be careful: the .env file usually ends up in the build artifacts.
+   * Use this for apps and clients where env does not contain any secrets
+   *
+   *
+   * if set to "local" it will only create .env file locally.
+   * Use this in combination with @dotenvx/dotenvx or node 20 to start apps locally with .env files
+   * During build and runtime, it relies on the env vars set in the environment
+   *
    */
-  dotEnv?: boolean;
+  dotEnv?: boolean | "local";
   /**
-   * experimental. whether to create a env.d.ts localy and during build jobs
+   * whether to create a env.d.ts localy and during build jobs
    *
    * Be careful, this will overwrite any existing env.d.ts file!
    */