@catladder/pipeline 3.31.0 → 3.32.1

package/examples/custom-docker-file.test.ts

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

package/examples/custom-docker-file.ts

@@ -0,0 +1,36 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+        jobImage: "foo",
+        docker: {
+          type: "custom",
+          dockerfileContent: [
+            "FROM node:22",
+            "USER node",
+            "$DOCKER_COPY_WORKSPACE_FILES",
+            "WORKDIR /app/$APP_DIR",
+            "$DOCKER_COPY_AND_INSTALL_APP",
+          ],
+        },
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "asdf",
+        region: "asia-east1",
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Custom Dockerfile",
+};

package/package.json

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

package/src/build/artifacts/createBuildJobArtifact.ts

@@ -8,6 +8,9 @@ import type { CatladderJob } from "../../types/jobs";
 import { uniq } from "lodash";
 import { componentContextNeedsBuildTimeDotEnv } from "../base/writeDotEnv";
 
+const uniqueAndAlphabeticalSort = (arr: string[]): string[] => {
+  return uniq(arr).sort((a, b) => a.localeCompare(b));
+};
 export const createBuildJobArtifacts = (
   context: Context,
 ): CatladderJob["artifacts"] => {
@@ -23,8 +26,10 @@ export const createBuildJobArtifacts = (
         )
       : getAllArtifactExcludePathsForComponent(context);
   return {
-    paths: uniq(paths).sort((a, b) => a.localeCompare(b)),
-    ...(exclude.length > 0 ? { exclude } : {}),
+    paths: uniqueAndAlphabeticalSort(paths),
+    ...(exclude.length > 0
+      ? { exclude: uniqueAndAlphabeticalSort(exclude) }
+      : {}),
     expire_in: "1 day",
     when: "always",
     reports:

package/src/build/docker.ts

@@ -166,19 +166,39 @@ const BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS = {
   [type in BuildConfigDocker["type"]]: string | null;
 };
 
-export const getDockerBuildScriptWithBuiltInDockerFile = (
+const getEnsureDockerFileScript = (
   context: ComponentContextWithBuild,
-  defaultType?: BuildConfigDocker["type"],
+  fallbackType?: BuildConfigDocker["type"],
 ) => {
-  const type =
+  if (
     "docker" in context.build.config &&
     context.build.config.docker &&
     "type" in context.build.config.docker
-      ? context.build.config.docker?.type
-      : defaultType;
+  ) {
+    if (context.build.config.docker?.type === "custom") {
+      if (context.build.config.docker?.dockerfileContent) {
+        // we need to create a script that creates a Dockerfile in the current directory
+        return `
+echo "Creating Dockerfile"
+cat >$APP_DIR/Dockerfile <<EOF
+${context.build.config.docker?.dockerfileContent?.join("\n")}
+EOF`;
+      }
+    }
+
+    const type = context.build.config.docker?.type ?? fallbackType;
+    return type ? BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS[type] : null;
+  }
+  return fallbackType ? BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS[fallbackType] : null;
+};
+
+export const getDockerBuildScriptWithBuiltInDockerFile = (
+  context: ComponentContextWithBuild,
+  fallbackType?: BuildConfigDocker["type"],
+) => {
   return getDockerBuildDefaultScript(
     context,
-    type ? BUILT_IN_ENSURE_DOCKERFILE_SCRIPTS[type] : null,
+    getEnsureDockerFileScript(context, fallbackType),
   );
 };
 export const getDockerBuildDefaultScript = (

package/src/build/types.ts

@@ -244,6 +244,16 @@ type BuildConfigDockerCustom = {
    * Depending on your Dockerfile you may want to change it to "component"
    */
   buildContextLocation?: "root" | "component";
+
+  /**
+   * EXPERIMENTAL: custom docker file content
+   *
+   * you can use some predefined variables:
+   * - $DOCKER_COPY_WORKSPACE_FILES
+   * - $DOCKER_COPY_AND_INSTALL_APP
+   * - and all default variables
+   */
+  dockerfileContent?: string[];
 };
 
 export type BuildConfigDocker =