@catladder/pipeline 1.153.0 → 1.154.0

package/examples/__snapshots__/native-app.ts.snap

@@ -62,8 +62,8 @@ exports[`matches snapshot 1`] = `
           "expire_in": "1 day",
           "paths": [
             "api/__build_info.json",
-            "api/dist",
             "api/.next",
+            "api/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -88,7 +88,7 @@ exports[`matches snapshot 1`] = `
           {
             "key": "api-next-cache",
             "paths": [
-              "api/.next/cache/",
+              "api/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -570,8 +570,8 @@ EOF
           "expire_in": "1 day",
           "paths": [
             "app/__build_info.json",
-            "app/dist",
             "app/.next",
+            "app/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -606,7 +606,7 @@ EOF
           {
             "key": "app-next-cache",
             "paths": [
-              "app/.next/cache/",
+              "app/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -642,6 +642,7 @@ EOF
           "export LC_A="L=en_US.UTF-8"",
           "export LANG="en_US.UTF-8"",
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
+          "echo -e "\\e[0Ksection_start:$(date +%s):write-dotenv-app[collapsed=true]\\r\\e[0Kwrite dot env"",
           "cat <<EOF > app/.env
 ENV_SHORT=dev
 APP_DIR=app
@@ -660,6 +661,7 @@ APP_STORE_CONNECT_API_KEY_ID=$CL_dev_app_APP_STORE_CONNECT_API_KEY_ID
 GRAPHQL_URL=https://$(printf %s "pan-test-app-dev-api-$CL_dev_api_GCLOUD_RUN_canonicalHostSuffix" | awk '{print tolower($0)}')/graphql
 _ALL_ENV_VAR_KEYS=["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_BUILD_ID","BUILD_INFO_BUILD_TIME","BUILD_INFO_CURRENT_VERSION","HOST","ROOT_URL","HOST_INTERNAL","HOST_CANONICAL","ROOT_URL_INTERNAL","APP_STORE_CONNECT_API_KEY_CONTENT","APP_STORE_CONNECT_ISSUER_ID","APP_STORE_CONNECT_API_KEY_ID","GRAPHQL_URL"]
 EOF",
+          "echo -e "\\e[0Ksection_end:$(date +%s):write-dotenv-app\\r\\e[0K"",
           "echo '{"id":"$(git describe --tags 2>/dev/null || git rev-parse HEAD)","time":"$CI_JOB_STARTED_AT"}' > app/__build_info.json",
           "echo -e "\\e[0Ksection_start:$(date +%s):nodeinstall[collapsed=true]\\r\\e[0KEnsure node version"",
           "if [ -f ~/.nvm/nvm.sh ];  then source ~/.nvm/nvm.sh; fi",
@@ -1012,8 +1014,8 @@ EOF",
           "expire_in": "1 day",
           "paths": [
             "api/__build_info.json",
-            "api/dist",
             "api/.next",
+            "api/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1038,7 +1040,7 @@ EOF",
           {
             "key": "api-next-cache",
             "paths": [
-              "api/.next/cache/",
+              "api/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -1526,8 +1528,8 @@ EOF
           "expire_in": "1 day",
           "paths": [
             "app/__build_info.json",
-            "app/dist",
             "app/.next",
+            "app/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1562,7 +1564,7 @@ EOF
           {
             "key": "app-next-cache",
             "paths": [
-              "app/.next/cache/",
+              "app/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -1598,6 +1600,7 @@ EOF
           "export LC_A="L=en_US.UTF-8"",
           "export LANG="en_US.UTF-8"",
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
+          "echo -e "\\e[0Ksection_start:$(date +%s):write-dotenv-app[collapsed=true]\\r\\e[0Kwrite dot env"",
           "cat <<EOF > app/.env
 ENV_SHORT=review
 APP_DIR=app
@@ -1616,6 +1619,7 @@ APP_STORE_CONNECT_API_KEY_ID=$CL_review_app_APP_STORE_CONNECT_API_KEY_ID
 GRAPHQL_URL=https://$(printf %s "pan-test-app-review-$([ -n "$CI_MERGE_REQUEST_IID" ] && echo "mr$CI_MERGE_REQUEST_IID" || { [ -n "$CI_COMMIT_REF_SLUG" ] && echo "$CI_COMMIT_REF_SLUG" || echo "unknown"; })-api-$CL_review_api_GCLOUD_RUN_canonicalHostSuffix" | awk '{print tolower($0)}')/graphql
 _ALL_ENV_VAR_KEYS=["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_BUILD_ID","BUILD_INFO_BUILD_TIME","BUILD_INFO_CURRENT_VERSION","HOST","ROOT_URL","HOST_INTERNAL","HOST_CANONICAL","ROOT_URL_INTERNAL","APP_STORE_CONNECT_API_KEY_CONTENT","APP_STORE_CONNECT_ISSUER_ID","APP_STORE_CONNECT_API_KEY_ID","GRAPHQL_URL"]
 EOF",
+          "echo -e "\\e[0Ksection_end:$(date +%s):write-dotenv-app\\r\\e[0K"",
           "echo '{"id":"$(git describe --tags 2>/dev/null || git rev-parse HEAD)","time":"$CI_JOB_STARTED_AT"}' > app/__build_info.json",
           "echo -e "\\e[0Ksection_start:$(date +%s):nodeinstall[collapsed=true]\\r\\e[0KEnsure node version"",
           "if [ -f ~/.nvm/nvm.sh ];  then source ~/.nvm/nvm.sh; fi",
@@ -1916,8 +1920,8 @@ EOF",
           "expire_in": "1 day",
           "paths": [
             "api/__build_info.json",
-            "api/dist",
             "api/.next",
+            "api/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1942,7 +1946,7 @@ EOF",
           {
             "key": "api-next-cache",
             "paths": [
-              "api/.next/cache/",
+              "api/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -2003,8 +2007,8 @@ EOF",
           "expire_in": "1 day",
           "paths": [
             "api/__build_info.json",
-            "api/dist",
             "api/.next",
+            "api/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -2029,7 +2033,7 @@ EOF",
           {
             "key": "api-next-cache",
             "paths": [
-              "api/.next/cache/",
+              "api/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -2641,8 +2645,8 @@ EOF
           "expire_in": "1 day",
           "paths": [
             "app/__build_info.json",
-            "app/dist",
             "app/.next",
+            "app/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -2677,7 +2681,7 @@ EOF
           {
             "key": "app-next-cache",
             "paths": [
-              "app/.next/cache/",
+              "app/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -2713,6 +2717,7 @@ EOF
           "export LC_A="L=en_US.UTF-8"",
           "export LANG="en_US.UTF-8"",
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
+          "echo -e "\\e[0Ksection_start:$(date +%s):write-dotenv-app[collapsed=true]\\r\\e[0Kwrite dot env"",
           "cat <<EOF > app/.env
 ENV_SHORT=prod
 APP_DIR=app
@@ -2731,6 +2736,7 @@ APP_STORE_CONNECT_API_KEY_ID=$CL_prod_app_APP_STORE_CONNECT_API_KEY_ID
 GRAPHQL_URL=https://$(printf %s "pan-test-app-prod-api-$CL_prod_api_GCLOUD_RUN_canonicalHostSuffix" | awk '{print tolower($0)}')/graphql
 _ALL_ENV_VAR_KEYS=["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_BUILD_ID","BUILD_INFO_BUILD_TIME","BUILD_INFO_CURRENT_VERSION","HOST","ROOT_URL","HOST_INTERNAL","HOST_CANONICAL","ROOT_URL_INTERNAL","APP_STORE_CONNECT_API_KEY_CONTENT","APP_STORE_CONNECT_ISSUER_ID","APP_STORE_CONNECT_API_KEY_ID","GRAPHQL_URL"]
 EOF",
+          "echo -e "\\e[0Ksection_end:$(date +%s):write-dotenv-app\\r\\e[0K"",
           "echo '{"id":"$(git describe --tags 2>/dev/null || git rev-parse HEAD)","time":"$CI_JOB_STARTED_AT"}' > app/__build_info.json",
           "echo -e "\\e[0Ksection_start:$(date +%s):nodeinstall[collapsed=true]\\r\\e[0KEnsure node version"",
           "if [ -f ~/.nvm/nvm.sh ];  then source ~/.nvm/nvm.sh; fi",
@@ -2768,8 +2774,8 @@ EOF",
           "expire_in": "1 day",
           "paths": [
             "app/__build_info.json",
-            "app/dist",
             "app/.next",
+            "app/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -2804,7 +2810,7 @@ EOF",
           {
             "key": "app-next-cache",
             "paths": [
-              "app/.next/cache/",
+              "app/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -2840,6 +2846,7 @@ EOF",
           "export LC_A="L=en_US.UTF-8"",
           "export LANG="en_US.UTF-8"",
           "echo -e "\\e[0Ksection_end:$(date +%s):injectvars\\r\\e[0K"",
+          "echo -e "\\e[0Ksection_start:$(date +%s):write-dotenv-app[collapsed=true]\\r\\e[0Kwrite dot env"",
           "cat <<EOF > app/.env
 ENV_SHORT=stage
 APP_DIR=app
@@ -2858,6 +2865,7 @@ APP_STORE_CONNECT_API_KEY_ID=$CL_stage_app_APP_STORE_CONNECT_API_KEY_ID
 GRAPHQL_URL=https://$(printf %s "pan-test-app-stage-api-$CL_stage_api_GCLOUD_RUN_canonicalHostSuffix" | awk '{print tolower($0)}')/graphql
 _ALL_ENV_VAR_KEYS=["ENV_SHORT","APP_DIR","ENV_TYPE","BUILD_INFO_BUILD_ID","BUILD_INFO_BUILD_TIME","BUILD_INFO_CURRENT_VERSION","HOST","ROOT_URL","HOST_INTERNAL","HOST_CANONICAL","ROOT_URL_INTERNAL","APP_STORE_CONNECT_API_KEY_CONTENT","APP_STORE_CONNECT_ISSUER_ID","APP_STORE_CONNECT_API_KEY_ID","GRAPHQL_URL"]
 EOF",
+          "echo -e "\\e[0Ksection_end:$(date +%s):write-dotenv-app\\r\\e[0K"",
           "echo '{"id":"$(git describe --tags 2>/dev/null || git rev-parse HEAD)","time":"$CI_JOB_STARTED_AT"}' > app/__build_info.json",
           "echo -e "\\e[0Ksection_start:$(date +%s):nodeinstall[collapsed=true]\\r\\e[0KEnsure node version"",
           "if [ -f ~/.nvm/nvm.sh ];  then source ~/.nvm/nvm.sh; fi",

package/examples/__snapshots__/node-build-with-custom-image.ts.snap

@@ -62,8 +62,8 @@ exports[`matches snapshot 1`] = `
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -88,7 +88,7 @@ exports[`matches snapshot 1`] = `
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -635,8 +635,8 @@ EOF
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -661,7 +661,7 @@ EOF
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -1162,8 +1162,8 @@ EOF
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1188,7 +1188,7 @@ EOF
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -1249,8 +1249,8 @@ EOF
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1275,7 +1275,7 @@ EOF
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },

package/examples/__snapshots__/node-build-with-docker-additions.ts.snap

@@ -62,8 +62,8 @@ exports[`matches snapshot 1`] = `
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -88,7 +88,7 @@ exports[`matches snapshot 1`] = `
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -637,8 +637,8 @@ EOF
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -663,7 +663,7 @@ EOF
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -1166,8 +1166,8 @@ EOF
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1192,7 +1192,7 @@ EOF
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -1253,8 +1253,8 @@ EOF
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1279,7 +1279,7 @@ EOF
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },

package/examples/__snapshots__/wait-for-other-deploy.ts.snap

@@ -62,8 +62,8 @@ exports[`matches snapshot 1`] = `
           "expire_in": "1 day",
           "paths": [
             "api/__build_info.json",
-            "api/dist",
             "api/.next",
+            "api/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -88,7 +88,7 @@ exports[`matches snapshot 1`] = `
           {
             "key": "api-next-cache",
             "paths": [
-              "api/.next/cache/",
+              "api/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -366,8 +366,8 @@ exports[`matches snapshot 1`] = `
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -392,7 +392,7 @@ exports[`matches snapshot 1`] = `
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -744,8 +744,8 @@ exports[`matches snapshot 1`] = `
           "expire_in": "1 day",
           "paths": [
             "api/__build_info.json",
-            "api/dist",
             "api/.next",
+            "api/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -770,7 +770,7 @@ exports[`matches snapshot 1`] = `
           {
             "key": "api-next-cache",
             "paths": [
-              "api/.next/cache/",
+              "api/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -1048,8 +1048,8 @@ exports[`matches snapshot 1`] = `
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1074,7 +1074,7 @@ exports[`matches snapshot 1`] = `
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -1374,8 +1374,8 @@ exports[`matches snapshot 1`] = `
           "expire_in": "1 day",
           "paths": [
             "api/__build_info.json",
-            "api/dist",
             "api/.next",
+            "api/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1400,7 +1400,7 @@ exports[`matches snapshot 1`] = `
           {
             "key": "api-next-cache",
             "paths": [
-              "api/.next/cache/",
+              "api/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -1457,8 +1457,8 @@ exports[`matches snapshot 1`] = `
           "expire_in": "1 day",
           "paths": [
             "api/__build_info.json",
-            "api/dist",
             "api/.next",
+            "api/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1483,7 +1483,7 @@ exports[`matches snapshot 1`] = `
           {
             "key": "api-next-cache",
             "paths": [
-              "api/.next/cache/",
+              "api/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -1698,8 +1698,8 @@ exports[`matches snapshot 1`] = `
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1724,7 +1724,7 @@ exports[`matches snapshot 1`] = `
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },
@@ -1781,8 +1781,8 @@ exports[`matches snapshot 1`] = `
           "expire_in": "1 day",
           "paths": [
             "www/__build_info.json",
-            "www/dist",
             "www/.next",
+            "www/dist",
           ],
           "reports": {
             "junit": undefined,
@@ -1807,7 +1807,7 @@ exports[`matches snapshot 1`] = `
           {
             "key": "www-next-cache",
             "paths": [
-              "www/.next/cache/",
+              "www/.next/cache",
             ],
             "policy": "pull-push",
           },

package/examples/cloud-run-with-sql.ts

@@ -3,11 +3,17 @@ import { createAllPipelines } from "./__utils__/helpers";
 const config: Config = {
   appName: "test-app",
   customerName: "pan",
+  builds: {
+    myWorkspace: {
+      type: "node",
+    },
+  },
   components: {
     api: {
+      dotEnv: true,
       dir: "api",
       build: {
-        type: "node",
+        from: "myWorkspace",
       },
       deploy: {
         type: "google-cloudrun",
@@ -39,9 +45,10 @@ const config: Config = {
       },
     },
     www: {
+      dotEnv: true,
       dir: "www",
       build: {
-        type: "node",
+        from: "myWorkspace",
       },
       deploy: {
         type: "google-cloudrun",

package/package.json

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

package/src/build/artifacts/createBuildJobArtifact.ts

@@ -0,0 +1,61 @@
+import { join } from "path";
+import {
+  componentContextIsStandaloneBuild,
+  type ComponentContext,
+  type Context,
+} from "../../types";
+import type { CatladderJob } from "../../types/jobs";
+import { uniq } from "lodash";
+import { componentContextNeedsBuildTimeDotEnv } from "../base/writeDotEnv";
+
+export const createBuildJobArtifacts = (
+  context: Context,
+): CatladderJob["artifacts"] => {
+  const paths =
+    context.type === "workspace"
+      ? context.components.flatMap((c) => getArtifactsPathForComponent(c))
+      : getArtifactsPathForComponent(context, ["__build_info.json"]);
+  // esxclude .env files if generated
+  const exclude =
+    context.type === "workspace"
+      ? context.components.flatMap((c) => getDotEnvPathsForComponent(c))
+      : getDotEnvPathsForComponent(context);
+  return {
+    paths: uniq(paths).sort((a, b) => a.localeCompare(b)),
+    ...(exclude.length > 0 ? { exclude } : {}),
+    expire_in: "1 day",
+    when: "always",
+    reports:
+      // TODO: support for junit reports in other builds
+      context.type === "component" && componentContextIsStandaloneBuild(context)
+        ? {
+            junit: context.build.config.artifactsReports?.junit?.map((p) =>
+              join(context.build.dir, p),
+            ),
+          }
+        : {},
+  };
+};
+const getArtifactsPathForComponent = (
+  c: ComponentContext,
+  additionalPaths?: string[],
+): string[] => {
+  return [
+    ...(c.build.config.artifactsPaths ?? []),
+    ...(additionalPaths ?? []),
+  ]?.flatMap((artifact) =>
+    c.build
+      // in theory, we only need "direct",
+      // but in some cases project may have packages in the workspace that create build artifacts, which aren't components
+      // this highly depends on the build tool. To be safe, we get all
+      .getComponentDirs("all")
+      .flatMap((cDir) => join(cDir, artifact)),
+  );
+};
+
+const getDotEnvPathsForComponent = (c: ComponentContext): string[] => {
+  if (componentContextNeedsBuildTimeDotEnv(c)) {
+    return [join(c.build.dir, ".env")];
+  }
+  return [];
+};