@catladder/pipeline 1.102.0 → 1.103.0

package/examples/native-app.ts

@@ -0,0 +1,81 @@
+import type { Config } from "../src";
+import type { CatladderJob } from "../src/types/jobs";
+import { createAllPipelines } from "./__utils__/helpers";
+const APP_GEM_CACHE: CatladderJob["cache"] = [
+  {
+    key: {
+      files: ["app/Gemfile.lock"],
+    },
+    paths: ["app/vendor"],
+  },
+];
+
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    app: {
+      dir: "app",
+      dotEnv: true,
+      vars: {
+        public: {
+          GRAPHQL_URL: "${api:ROOT_URL}/graphql",
+        },
+        secret: [
+          "APP_STORE_CONNECT_API_KEY_CONTENT",
+          "APP_STORE_CONNECT_ISSUER_ID",
+          "APP_STORE_CONNECT_API_KEY_ID",
+        ],
+      },
+      build: {
+        extraVars: {
+          LC_A: "L=en_US.UTF-8",
+          LANG: "en_US.UTF-8",
+        },
+        type: "node",
+        buildCommand: [
+          "bundle config set --local path 'vendor/ruby'",
+          "gem install bundler",
+          "bundle install",
+          "bundle exec pod install --project-directory=ios",
+          "bundle exec fastlane build",
+        ],
+        jobTags: ["mac-runner"],
+        jobCache: APP_GEM_CACHE,
+      },
+
+      deploy: {
+        type: "custom",
+        extraVars: {
+          LC_A: "L=en_US.UTF-8",
+          LANG: "en_US.UTF-8",
+        },
+        requiresDocker: false,
+        script: [
+          "bundle config set --local path 'vendor/ruby'",
+          "gem install bundler",
+          "bundle install",
+          "bundle exec fastlane deploy_test",
+        ],
+        jobTags: ["mac-runner"],
+        jobCache: APP_GEM_CACHE,
+      },
+    },
+
+    api: {
+      dir: "api",
+      build: {
+        type: "node",
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+    },
+  },
+};
+
+it("matches snapshot", async () => {
+  expect(await createAllPipelines(config)).toMatchSnapshot();
+});

package/package.json

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

package/src/build/base/createBuildJob.ts

@@ -10,6 +10,7 @@ import {
   RUNNER_BUILD_RESOURCE_VARIABLES,
 } from "./constants";
 import { writeBuildInfo } from "./writeBuildInfo";
+import { writeDotEnv } from "./writeDotEnv";
 
 export const createBuildJob = (
   context: Context,
@@ -32,6 +33,7 @@ export const createBuildJob = (
       },
 
       script: [
+        ...(context.componentConfig.dotEnv ? 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/build/base/writeDotEnv.ts

@@ -0,0 +1,21 @@
+import type { Context } from "../../types";
+
+/**
+ * writes a .env file in the components folder
+ * @param context
+ * @returns
+ */
+export const writeDotEnv = (context: Context) => {
+  const envVars = context.environment.envVars;
+
+  // make key=value and sanitize multiline
+  const keyValueString = Object.entries(envVars)
+    .map(([key, value]) => `${key}=${value.replaceAll("\n", "\\n")}`)
+    .join("\n");
+
+  return [
+    `cat <<EOF > ${context.componentConfig.dir}/.env
+${keyValueString}
+EOF`,
+  ];
+};

package/src/types/config.ts

@@ -144,6 +144,13 @@ export type ComponentConfig<C extends ConfigProps = never> = {
    * This feedback will help us to generalize use cases
    */
   customJobs?: CatladderJob[] | ((context: Context) => CatladderJob[]);
+
+  /**
+   * experimental. whether to create a .env localy and during build jobs
+   *
+   * Be careful, this will overwrite any existing .env file!
+   */
+  dotEnv?: boolean;
 } & DefaultEnvConfig;
 
 export type ConfigProps = {

package/tsconfig.json

@@ -1,6 +1,6 @@
 {
   "compilerOptions": {
-    "lib": ["es2020", "DOM"],
+    "lib": ["es2021", "DOM"],
     "strict": true,
     "module": "CommonJS",
     "downlevelIteration": true,