@catladder/pipeline 1.153.0 → 1.154.0

package/src/types/context.ts

@@ -1,12 +1,16 @@
 import type { StringOrBashExpression } from "../bash/BashExpression";
-import type { BuildConfig } from "../build";
+import type {
+  BuildConfigFromWorkspace,
+  BuildConfigStandalone,
+  WorkspaceBuildConfig,
+} from "../build";
 import type { PredefinedVariables, SecretEnvVar } from "../context";
 import type { DeployConfig } from "../deploy";
 import type {
-  PipelineTrigger,
   ComponentConfig,
   Config,
   EnvType,
+  PipelineTrigger,
 } from "./config";
 import type { BaseStage, CatladderJob } from "./jobs";
 import type { PipelineType } from "./pipeline";
@@ -42,7 +46,9 @@ export type Environment = {
    * the full name of the app. We use this as RELEASE_NAME in kubernetes and the service name in google cloud run
    */
   fullName: StringOrBashExpression;
-
+  /**
+   * @deprecated this is the same as context.env, use that instead
+   */
   shortName: string;
   /**
    * the environment slug without component name.
@@ -66,12 +72,15 @@ export type YarnWorkspace = {
   workspaceDependencies: string[];
   mismatchedWorkspaceDependencies: string[];
 };
-export type YarnPackageManagerInfoComponent = {
+export type YarnPackageManagerInfoBase = {
   type: "yarn";
   version: string;
   workspaces: YarnWorkspace[];
-  currentWorkspace?: YarnWorkspace;
   isClassic: boolean;
+};
+
+export type YarnPackageManagerInfoComponent = YarnPackageManagerInfoBase & {
+  currentWorkspace?: YarnWorkspace;
   componentIsInWorkspace: boolean;
   pathsToCopyInDocker: string[];
   currentWorkspaceDependencies: string[];
@@ -79,25 +88,80 @@ export type YarnPackageManagerInfoComponent = {
 
 export type PackageManagerInfoComponent = YarnPackageManagerInfoComponent;
 
+/**
+ * not confuse with yarn workspaces
+ */
+export type PackageManagerInfoBase = YarnPackageManagerInfoBase;
+
 export type ContextBeforeConfig = {
   componentName: string;
   fullConfig: Config;
   packageManagerInfo?: PackageManagerInfoComponent;
 };
 
-export type BuildContextComponent = {
+export type BuildContextBase = {
+  /**
+   * the directory where the component or workspace is located
+   */
   dir: string;
+  /**
+   * directories of all components that are part of the build.
+   * In case of a standalone build, this is just the dir of the component + yarn workspace dependencies (if mode = all)
+   *
+   * in case of a workspace this contains all components in the workspace (+ yarn workspace dependencies if mode = all)
+   */
+  getComponentDirs: (mode: "direct" | "all") => string[];
+};
+
+export type BuildContextComponentBase = BuildContextBase;
+
+export type BuildContextStandalone<
+  C extends BuildConfigStandalone = BuildConfigStandalone,
+> = BuildContextComponentBase & {
+  config: C;
+  type: "standalone";
+  buildType: C["type"];
+};
+
+export type BuildContextFromWorkspace = BuildContextComponentBase & {
+  config: BuildConfigFromWorkspace;
+  workspaceName: string;
+  buildType: WorkspaceBuildConfig["type"];
+  /**
+   * merged docker config
+   */
+  workspaceBuildConfig: WorkspaceBuildConfig;
+  type: "fromWorkspace";
+};
 
-  config: BuildConfig;
+export type BuildContextWorkspace = BuildContextBase & {
+  type: "workspace";
+  buildType: WorkspaceBuildConfig["type"];
+  config: WorkspaceBuildConfig;
 };
 
-export type BuildContext = BuildContextComponent;
+export type BuildContextComponent =
+  | BuildContextStandalone
+  | BuildContextFromWorkspace;
+
+export type BuildContext = BuildContextComponent | BuildContextWorkspace;
+
 export type DeployContext = {
   config: DeployConfig;
 };
-export type ComponentContext = {
-  componentName: string;
+export type ComponentContext<
+  BC extends BuildContextComponent = BuildContextComponent,
+> = {
+  type: "component";
   env: string;
+  /**
+   * the name of the component
+   */
+  name: string;
+  /**
+   * @deprecated use name instead
+   */
+  componentName: string;
 
   /**
    * the merged component config.
@@ -106,7 +170,7 @@ export type ComponentContext = {
    *
    */
   componentConfig: ComponentConfig;
-  build: BuildContextComponent;
+  build: BC;
   deploy?: DeployContext | null;
   fullConfig: Config;
   environment: Environment;
@@ -119,4 +183,36 @@ export type ComponentContext = {
   customJobs?: CatladderJob[];
 };
 
-export type Context = ComponentContext;
+export type Context = ComponentContext | WorkspaceContext;
+
+export type CatladderJobWithContext<S = BaseStage> = CatladderJob<S> & {
+  context: ComponentContext;
+};
+
+export const componentContextIsStandaloneBuild = (
+  context: ComponentContext<BuildContextComponent>,
+): context is ComponentContext<BuildContextStandalone> => {
+  return context.build.type === "standalone";
+};
+
+export const componentContextHasWorkspaceBuild = (
+  context: ComponentContext<BuildContextComponent>,
+): context is ComponentContext<BuildContextFromWorkspace> => {
+  return context.build.type === "fromWorkspace";
+};
+
+export type WorkspaceContext = {
+  type: "workspace";
+  /**
+   * the name of the workspace
+   */
+  name: string;
+  fullConfig: Config;
+  workspaceConfig: WorkspaceBuildConfig;
+  packageManagerInfo: PackageManagerInfoBase;
+  components: Array<ComponentContext>;
+  build: BuildContextWorkspace;
+  trigger: PipelineTrigger;
+  pipelineType: PipelineType;
+  env: string;
+};

package/src/types/environmentContext.ts

@@ -1,17 +1,16 @@
 import type { StringOrBashExpression } from "../bash/BashExpression";
-import type { BuildConfigGeneric, BuildConfigType } from "../build";
-import type { DeployConfigGeneric } from "../deploy";
-import type { DeployConfigType } from "../deploy";
+import type { BuildConfig } from "../build";
+import type { DeployConfig } from "../deploy";
 import type { Config, EnvConfigWithComponent, EnvType } from "./config";
 import type { PipelineType } from "./pipeline";
 
 export type EnvironmentContext<
-  B extends BuildConfigType,
-  D extends DeployConfigType,
+  B extends BuildConfig = BuildConfig,
+  D extends DeployConfig = DeployConfig,
 > = {
   envConfigRaw: EnvConfigWithComponent;
-  buildConfigRaw: false | BuildConfigGeneric<B>;
-  deployConfigRaw: false | DeployConfigGeneric<D>;
+  buildConfigRaw: false | B;
+  deployConfigRaw: false | D;
 
   env: string;
   envType: EnvType;

package/src/types/jobs.ts

@@ -25,7 +25,8 @@ export type BaseStage = (typeof BASE_STAGES)[number];
 
 export type CatladderJobNeed =
   | string
-  | { job: string; artifacts: boolean; componentName?: string };
+  | { job: string; artifacts: boolean; componentName?: string }
+  | { job: string; artifacts: boolean; workspaceName: string };
 
 export type CatladderJobEnvironmentConfig = {
   action?: GitlabEnvironment["action"];
@@ -61,6 +62,7 @@ export type CatladderJob<S = BaseStage> = {
   needsStages?: {
     stage: S;
     artifacts?: boolean;
+    workspaceName?: string;
   }[];
 
   /**