@catladder/pipeline 1.168.0 → 1.168.1

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

@@ -262,7 +262,6 @@ api 🧪 test:
     - yarn deploy
     - echo 'Uploading SBOM to Dependency Track'
     - /dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true
-  cache: []
   rules:
     - when: never
       if: $CI_COMMIT_MESSAGE =~ /^chore\\(release\\).*/
@@ -387,7 +386,6 @@ api 🧪 test:
     - yarn deploy
     - echo 'Uploading SBOM to Dependency Track'
     - /dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true
-  cache: []
   rules:
     - when: on_success
       if: $CI_MERGE_REQUEST_ID
@@ -510,7 +508,6 @@ api 🧪 test:
     - yarn deploy
     - echo 'Uploading SBOM to Dependency Track'
     - /dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true
-  cache: []
   rules:
     - when: on_success
       if: $CI_COMMIT_TAG
@@ -627,7 +624,6 @@ api 🧪 test:
     - yarn deploy
     - echo 'Uploading SBOM to Dependency Track'
     - /dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/api" "https://unknown-host.example.com" "__sbom.json" vex.json || true
-  cache: []
   rules:
     - when: manual
       if: $CI_COMMIT_TAG
@@ -852,7 +848,6 @@ www 🧪 test:
     - yarn deploy
     - echo 'Uploading SBOM to Dependency Track'
     - /dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true
-  cache: []
   rules:
     - when: never
       if: $CI_COMMIT_MESSAGE =~ /^chore\\(release\\).*/
@@ -979,7 +974,6 @@ www 🧪 test:
     - yarn deploy
     - echo 'Uploading SBOM to Dependency Track'
     - /dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true
-  cache: []
   rules:
     - when: on_success
       if: $CI_MERGE_REQUEST_ID
@@ -1104,7 +1098,6 @@ www 🧪 test:
     - yarn deploy
     - echo 'Uploading SBOM to Dependency Track'
     - /dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true
-  cache: []
   rules:
     - when: on_success
       if: $CI_COMMIT_TAG
@@ -1223,7 +1216,6 @@ www 🧪 test:
     - yarn deploy
     - echo 'Uploading SBOM to Dependency Track'
     - /dtrackuploader https://dep.panter.swiss/ "$DT_KEY_PROD" upload "pan-test-app/www" "https://unknown-host.example.com" "__sbom.json" vex.json || true
-  cache: []
   rules:
     - when: manual
       if: $CI_COMMIT_TAG

package/examples/native-app.ts

@@ -1,12 +1,12 @@
-import type { Config } from "../src";
+import type { CacheConfig, Config } from "../src";
 import type { CatladderJob } from "../src/types/jobs";
 
-const APP_GEM_CACHE: CatladderJob["cache"] = [
+const APP_GEM_CACHE: CacheConfig[] = [
   {
     key: {
-      files: ["app/Gemfile.lock"],
+      files: ["Gemfile.lock"],
     },
-    paths: ["app/vendor"],
+    paths: ["vendor"],
   },
 ];
 
@@ -41,7 +41,7 @@ const config: Config = {
           "bundle exec fastlane build",
         ],
         jobTags: ["mac-runner"],
-        jobCache: APP_GEM_CACHE,
+        cache: APP_GEM_CACHE,
       },
 
       deploy: {
@@ -58,7 +58,7 @@ const config: Config = {
           "bundle exec fastlane deploy_test",
         ],
         jobTags: ["mac-runner"],
-        jobCache: APP_GEM_CACHE,
+        cache: APP_GEM_CACHE,
       },
     },
 

package/package.json

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

package/src/build/base/createAppBuildJob.ts

@@ -5,7 +5,7 @@ import type {
   WorkspaceContext,
 } from "../..";
 import { getRunnerImage } from "../..";
-import type { JobDefintion } from "../../types/jobDefinition";
+import type { AppBuildJobDefinition } from "../../types/jobDefinition";
 import type { CatladderJob } from "../../types/jobs";
 import { ensureArray } from "../../utils";
 import { createBuildJobArtifacts } from "../artifacts/createBuildJobArtifact";
@@ -21,7 +21,6 @@ import {
   writeDotEnv,
 } from "./writeDotEnv";
 
-export type AppBuildJobDefinition = JobDefintion;
 export const createAppBuildJob = (
   context: ComponentContext<BuildContextStandalone> | WorkspaceContext,
   { script, variables, runnerVariables, cache, ...def }: AppBuildJobDefinition,

package/src/build/base/createBuildJobDefinition.ts

@@ -1,7 +1,6 @@
 import type { BuildConfigStandalone, WorkspaceBuildConfig } from "..";
 import { getRunnerImage } from "../../runner";
-import type { Context } from "../../types";
-import type { JobDefintion } from "../../types/jobDefinition";
+import type { AppBuildJobDefinition, Context } from "../../types";
 import { ensureArray } from "../../utils";
 import { getAllCacheConfigsFromConfig } from "../cache/getAllCacheConfigsFromConfig";
 import { NODE_RUNNER_BUILD_VARIABLES } from "../node/constants";
@@ -9,11 +8,11 @@ import { NODE_RUNNER_BUILD_VARIABLES } from "../node/constants";
 export const createBuildJobDefinition = (
   context: Context,
   buildConfig: BuildConfigStandalone | WorkspaceBuildConfig,
-  customize: Pick<JobDefintion, "cache"> & {
+  customize: Pick<AppBuildJobDefinition, "cache"> & {
     prescript?: string[];
     postscript?: string[];
   } = {},
-): JobDefintion | undefined => {
+): AppBuildJobDefinition | undefined => {
   if (buildConfig.buildCommand === null) return undefined;
 
   const defaultImage = getRunnerImage("jobs-default");

package/src/build/base/index.ts

@@ -5,12 +5,14 @@ import {
   componentContextIsStandaloneBuild,
   type ComponentContext,
 } from "../../types/context";
+import type {
+  AppBuildJobDefinition,
+  DockerBuildJobDefinition,
+} from "../../types/jobDefinition";
 import type { CatladderJob } from "../../types/jobs";
-import type { DockerBuildJobDefinition } from "../docker";
 import { createDockerBuildJobBase, requiresDockerBuild } from "../docker";
 import { createSbomBuildJob } from "../sbom";
 import { APP_BUILD_JOB_NAME } from "./constants";
-import type { AppBuildJobDefinition } from "./createAppBuildJob";
 import { createAppBuildJob } from "./createAppBuildJob";
 
 export const createComponentBuildJobs = (

package/src/build/cache/createJobCache.ts

@@ -1,13 +1,8 @@
 import { join } from "path";
-import type {
-  BuildConfigStandalone,
-  CacheConfig,
-  CacheConfigAdvanced,
-  CacheConfigSimple,
-  WorkspaceBuildConfig,
-} from "..";
+import type { CacheConfig, CacheConfigAdvanced, CacheConfigSimple } from "..";
 import type { Context } from "../../types";
 import type { CatladderJobCache } from "../../types/jobs";
+import type { WithCacheConfig } from "../types";
 import { getAllCacheConfigsFromConfig } from "./getAllCacheConfigsFromConfig";
 
 export const createJobCacheFromCacheConfigs = (
@@ -61,6 +56,7 @@ export const createJobCacheFromCacheConfigs = (
                   pathMode === "absolute" ? f : join(baseDir, f),
                 ),
               };
+
       return {
         key: transformedKey,
         policy: policy ?? "pull-push",
@@ -70,16 +66,17 @@ export const createJobCacheFromCacheConfigs = (
       };
     },
   );
+
   return [...advancedCaches, ...simpleCaches];
 };
 
 /** shortcut, used in some build types */
 export const createJobCacheFromConfig = (
   context: Context,
-  buildConfig: BuildConfigStandalone | WorkspaceBuildConfig,
+  configWithCache: WithCacheConfig,
 ) => {
   return createJobCacheFromCacheConfigs(
     context,
-    getAllCacheConfigsFromConfig(context, buildConfig),
+    getAllCacheConfigsFromConfig(context, configWithCache),
   );
 };

package/src/build/cache/getAllCacheConfigsFromConfig.ts

@@ -1,24 +1,17 @@
 import type { Context } from "../../types";
 import { ensureArray } from "../../utils/index";
-import type {
-  BuildConfigStandalone,
-  CacheConfig,
-  WorkspaceBuildConfig,
-} from "../types";
+import type { CacheConfig, WithCacheConfig } from "../types";
 import { transformLegacyJobCache } from "./transformLegacyJobCache";
 
 export const getAllCacheConfigsFromConfig = (
   context: Context,
-  buildConfig: BuildConfigStandalone | WorkspaceBuildConfig,
+  configWithCache: WithCacheConfig,
 ): CacheConfig[] => {
   return [
-    ...("jobCache" in buildConfig
-      ? transformLegacyJobCache(buildConfig.jobCache)
+    ...("jobCache" in configWithCache
+      ? transformLegacyJobCache(configWithCache.jobCache)
       : []),
-    ...ensureArray(buildConfig.cache).map((c) => ({
-      ...c,
-      context,
-    })),
+    ...ensureArray(configWithCache.cache),
     ...(context.type === "workspace"
       ? // also add cache configs of the components of that workspace
         context.components.flatMap<CacheConfig>(

package/src/build/docker.ts

@@ -10,7 +10,7 @@ import {
 } from "../deploy/cloudRun/artifactsRegistry";
 import { gcloudServiceAccountLoginCommands } from "../deploy/cloudRun/utils/gcloudServiceAccountLoginCommands";
 import { getRunnerImage } from "../runner";
-import type { ComponentContext, JobDefintion } from "../types";
+import type { ComponentContext, DockerBuildJobDefinition } from "../types";
 import type { CatladderJob } from "../types/jobs";
 import { collapseableSection } from "../utils/gitlab";
 import { createJobCacheFromCacheConfigs } from "./cache/createJobCache";
@@ -119,10 +119,9 @@ export const getDockerJobBaseProps = (): Pick<
   };
 };
 
-export type DockerBuildJobDefinition = JobDefintion;
 export const createDockerBuildJobBase = (
   context: ComponentContext,
-  { script, cache, ...def }: JobDefintion,
+  { script, cache, ...def }: DockerBuildJobDefinition,
 ): CatladderJob => {
   return merge(
     {

package/src/build/node/buildJob.ts

@@ -6,11 +6,13 @@ import {
   componentContextIsStandaloneBuild,
   type ComponentContext,
 } from "../../types/context";
+import type {
+  AppBuildJobDefinition,
+  DockerBuildJobDefinition,
+} from "../../types/jobDefinition";
 import type { CatladderJob } from "../../types/jobs";
 import { createComponentBuildJobs, createWorkspaceBuildJobs } from "../base";
-import type { AppBuildJobDefinition } from "../base/createAppBuildJob";
 import { createBuildJobDefinition } from "../base/createBuildJobDefinition";
-import type { DockerBuildJobDefinition } from "../docker";
 import { getDockerBuildScriptWithBuiltInDockerFile } from "../docker";
 import type { BuildConfigDocker } from "../types";
 import { getNextCache, getNodeCache, getYarnCache } from "./cache";

package/src/build/types.ts

@@ -53,6 +53,13 @@ export type WithCacheConfig = {
   cache config. All Paths are relative to the context dir.
   */
   cache?: CacheConfig | CacheConfig[];
+
+  /**
+   * customize cache for the job
+   *
+   * @deprecated use cache
+   */
+  jobCache?: CatladderJob["cache"];
 };
 
 export type TestJobCustom = {

package/src/deploy/base/deploy.ts

@@ -1,8 +1,10 @@
+import { createJobCacheFromCacheConfigs } from "../../build/cache/createJobCache";
 import {
   getDockerImageVariables,
   requiresDockerBuild,
 } from "../../build/docker";
 import { SBOM_BUILD_JOB_NAME } from "../../build/sbom";
+import type { DeployJobDefinition } from "../../types";
 import {
   componentContextHasWorkspaceBuild,
   type ComponentContext,
@@ -16,16 +18,6 @@ import { DEPLOY_RUNNER_VARIABLES } from "./variables";
 
 export const DEPLOY_JOB_NAME = "🚀 Deploy";
 
-export type DeployJobDefinition = Pick<
-  CatladderJob,
-  | "script"
-  | "variables"
-  | "image"
-  | "cache"
-  | "artifacts"
-  | "services"
-  | "runnerVariables"
->;
 export const createDeployJob = (
   context: ComponentContext,
   jobDefinition: DeployJobDefinition,
@@ -58,7 +50,9 @@ export const createDeployJob = (
     name: DEPLOY_JOB_NAME,
     script: jobDefinition.script,
     image: jobDefinition.image,
-    cache: jobDefinition.cache,
+    cache: jobDefinition.cache
+      ? createJobCacheFromCacheConfigs(context, jobDefinition.cache)
+      : undefined,
     artifacts: jobDefinition.artifacts,
     services: jobDefinition.services,
     envMode: "stagePerEnv", // makes it easier to run manual tasks er env

package/src/deploy/base/index.ts

@@ -1,8 +1,13 @@
 import type { ComponentContext } from "../../types/context";
+import type {
+  DeployJobDefinition,
+  RollbackJobDefinition,
+  StopJobDefinition,
+} from "../../types/jobDefinition";
 import type { CatladderJob } from "../../types/jobs";
-import { createDeployJob, type DeployJobDefinition } from "./deploy";
-import { createRollbackJob, type RollbackJobDefinition } from "./rollback";
-import { createStopJob, type StopJobDefinition } from "./stop";
+import { createDeployJob } from "./deploy";
+import { createRollbackJob } from "./rollback";
+import { createStopJob } from "./stop";
 
 export const createDeployementJobs = (
   context: ComponentContext,

package/src/deploy/base/rollback.ts

@@ -1,13 +1,10 @@
 import type { ComponentContext } from "../../types/context";
+import type { RollbackJobDefinition } from "../../types/jobDefinition";
 import type { CatladderJob } from "../../types/jobs";
 import { DEPLOY_RUNNER_VARIABLES } from "./variables";
 
 export const ROLLBACK_JOB_NAME = "↩️ Rollback ⚠️";
 
-export type RollbackJobDefinition = Pick<
-  CatladderJob,
-  "script" | "variables" | "runnerVariables" | "image"
->;
 export const createRollbackJob = (
   context: ComponentContext,
   jobDefinition: RollbackJobDefinition,

package/src/deploy/base/stop.ts

@@ -1,13 +1,10 @@
 import type { ComponentContext } from "../../types/context";
+import type { StopJobDefinition } from "../../types/jobDefinition";
 import type { CatladderJob } from "../../types/jobs";
 
 import { DEPLOY_RUNNER_VARIABLES } from "./variables";
 export const STOP_JOB_NAME = "🛑 Stop ⚠️";
 
-export type StopJobDefinition = Pick<
-  CatladderJob,
-  "script" | "variables" | "image" | "runnerVariables"
->;
 export const createStopJob = (
   context: ComponentContext,
   jobDefinition: StopJobDefinition,

package/src/deploy/custom/deployJob.ts

@@ -1,3 +1,4 @@
+import { getAllCacheConfigsFromConfig } from "../../build/cache/getAllCacheConfigsFromConfig";
 import { getYarnInstall } from "../../build/node/yarn";
 import { getRunnerImage } from "../../runner";
 import type { ComponentContext } from "../../types/context";
@@ -22,10 +23,11 @@ export const createCustomDeployJobs = (
   const yarnInstall = getYarnInstall(context, {
     noCustomPostInstall: true,
   });
-  return createDeployementJobs(context, {
+
+  const result = createDeployementJobs(context, {
     deploy: {
       image: deployConfig.jobImage ?? getRunnerImage("jobs-default"),
-      cache: deployConfig.jobCache ?? [],
+      cache: getAllCacheConfigsFromConfig(context, deployConfig),
       script: [
         `cd ${context.build.dir}`,
         ...(deployConfig.requiresYarnInstall ? yarnInstall : []),
@@ -45,4 +47,5 @@ export const createCustomDeployJobs = (
         }
       : undefined,
   });
+  return result;
 };

package/src/deploy/types/custom.ts

@@ -1,5 +1,5 @@
+import type { WithCacheConfig } from "../../build";
 import type { GitlabJobImage } from "../../types";
-import type { CatladderJob } from "../../types/jobs";
 import type { DeployConfigBase } from "./base";
 
 export type DeployConfigCustom = {
@@ -28,9 +28,5 @@ export type DeployConfigCustom = {
    * image to use
    */
   jobImage?: GitlabJobImage;
-
-  /**
-   * customize cache for the job
-   */
-  jobCache?: CatladderJob["cache"];
-} & DeployConfigBase;
+} & DeployConfigBase &
+  WithCacheConfig;

package/src/types/jobDefinition.ts

@@ -1,9 +1,34 @@
 import type { CacheConfig } from "../build";
-import { CacheConfigAdvanced, CacheConfigSimple } from "../build";
 import type { CatladderJob } from "./jobs";
 
-export type JobDefintion = Partial<
+// new intermediate types. Currently not widely used, but we will built a bit  more abstraction on top of this
+
+export type AppBuildJobDefinition = Partial<
   Omit<CatladderJob, "artifacts" | "cache">
 > & {
   cache?: CacheConfig[];
 };
+
+export type DockerBuildJobDefinition = AppBuildJobDefinition; // currently the same
+
+export type DeployJobDefinition = Pick<
+  CatladderJob,
+  | "script"
+  | "variables"
+  | "image"
+  | "artifacts"
+  | "services"
+  | "runnerVariables"
+> & {
+  cache?: CacheConfig[];
+};
+
+export type StopJobDefinition = Pick<
+  CatladderJob,
+  "script" | "variables" | "image" | "runnerVariables"
+>;
+
+export type RollbackJobDefinition = Pick<
+  CatladderJob,
+  "script" | "variables" | "runnerVariables" | "image"
+>;