@catladder/pipeline 1.109.1 → 1.110.0

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

@@ -0,0 +1,25 @@
+import type { Config } from "../src";
+import { createAllPipelines } from "./__utils__/helpers";
+
+const config: Config = {
+  appName: "test-app",
+  customerName: "pan",
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+        jobImage: "my-custom-image",
+      },
+      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.109.1",
+  "version": "1.110.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/src/build/node/buildJob.ts

@@ -9,6 +9,7 @@ import { getNextCache, getNodeCache, getYarnCache } from "./cache";
 import { NODE_RUNNER_BUILD_VARIABLES } from "./constants";
 import { getDockerAppCopyAndBuildScript, getYarnInstall } from "./yarn";
 import type { CatladderJob } from "../../types/jobs";
+import { getRunnerImage } from "../../runner";
 
 export const createNodeBuildJobs = (context: Context): CatladderJob[] => {
   const buildConfig = context.componentConfig.build;
@@ -17,10 +18,12 @@ export const createNodeBuildJobs = (context: Context): CatladderJob[] => {
     throw new Error("deploy config is not node, node-static or storybook");
   }
 
+  const defaultImage = getRunnerImage("jobs-default");
   const yarnInstall = getYarnInstall(context);
   const appBuildJob: CatladderJob | null =
     buildConfig.buildCommand !== null
       ? createBuildJob(context, {
+          image: buildConfig.jobImage ?? defaultImage,
           variables: {
             ...NODE_RUNNER_BUILD_VARIABLES,
           },

package/src/build/rails/test.ts

@@ -39,7 +39,8 @@ export const createRailsTestJobs = (context: Context): CatladderJob[] => {
 
           ...base,
           cache: undefined, // audit does not need bundle install and no cache
-          image: buildConfig.audit?.jobImage ?? defaultImage,
+          image:
+            buildConfig.audit?.jobImage ?? buildConfig.jobImage ?? defaultImage,
           script: [
             `cd ${context.componentConfig.dir}`,
             ...(ensureArray(buildConfig.audit?.command) ?? [
@@ -58,7 +59,8 @@ export const createRailsTestJobs = (context: Context): CatladderJob[] => {
 
           ...base,
           cache: bundlerCache,
-          image: buildConfig.lint?.jobImage ?? defaultImage,
+          image:
+            buildConfig.lint?.jobImage ?? buildConfig.jobImage ?? defaultImage,
           script: [
             `cd ${context.componentConfig.dir}`,
             ...bundlerInstall,
@@ -75,7 +77,8 @@ export const createRailsTestJobs = (context: Context): CatladderJob[] => {
 
           ...base,
           cache: bundlerCache,
-          image: buildConfig.test?.jobImage ?? defaultImage,
+          image:
+            buildConfig.test?.jobImage ?? buildConfig.jobImage ?? defaultImage,
           script: [
             `cd ${context.componentConfig.dir}`,
             ...bundlerInstall,

package/src/build/types.ts

@@ -93,6 +93,10 @@ export type BuildConfigBase = {
    * tags for the underlying job runner (e.g gitlab)
    */
   jobTags?: string[];
+  /**
+   * custom image to use
+   */
+  jobImage?: GitlabJobImage;
 };
 
 export type BuildConfigNodeBase = BuildConfigBase & {
@@ -142,7 +146,7 @@ export type BuildConfigCustom = Omit<
   "lint" | "test" | "audit"
 > & {
   type: "custom";
-  jobImage: string;
+  jobImage: GitlabJobImage;
   jobServices?: GitlabJobService[];
 
   docker: BuildConfigCustomDocker;

package/src/deploy/types/kubernetes.ts

@@ -140,6 +140,9 @@ export type KubernetesRedirect = {
   path?: string;
   /**
    * optional nginx config snippet, defaults to a 301 redirect to the environment host name name with the request path appended
+   *
+   * important: to get a literal `$` use `$$` to prevent variable expansion by gitlab
+   * see https://docs.gitlab.com/ee/ci/variables/#use-the--character-in-cicd-variables
    */
   rule?: string;
 };