@catladder/cli 1.153.0 → 1.154.0

package/dist/pipeline/src/types/context.d.ts

@@ -1,9 +1,9 @@
 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 } from "./config";
-import type { CatladderJob } from "./jobs";
+import type { ComponentConfig, Config, EnvType, PipelineTrigger } from "./config";
+import type { BaseStage, CatladderJob } from "./jobs";
 import type { PipelineType } from "./pipeline";
 export type UnspecifiedEnvVars = Record<string, StringOrBashExpression | undefined | null>;
 export type EnvironmentEnvVars<V extends UnspecifiedEnvVars = UnspecifiedEnvVars> = {
@@ -28,6 +28,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.
@@ -49,33 +52,78 @@ 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[];
 };
 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;
-    config: BuildConfig;
+    /**
+     * 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";
+};
+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.
      *
@@ -83,7 +131,7 @@ export type ComponentContext = {
      *
      */
     componentConfig: ComponentConfig;
-    build: BuildContextComponent;
+    build: BC;
     deploy?: DeployContext | null;
     fullConfig: Config;
     environment: Environment;
@@ -92,4 +140,24 @@ export type ComponentContext = {
     packageManagerInfo: PackageManagerInfoComponent;
     customJobs?: CatladderJob[];
 };
-export type Context = ComponentContext;
+export type Context = ComponentContext | WorkspaceContext;
+export type CatladderJobWithContext<S = BaseStage> = CatladderJob<S> & {
+    context: ComponentContext;
+};
+export declare const componentContextIsStandaloneBuild: (context: ComponentContext<BuildContextComponent>) => context is ComponentContext<BuildContextStandalone<BuildConfigStandalone>>;
+export declare const componentContextHasWorkspaceBuild: (context: ComponentContext<BuildContextComponent>) => context is ComponentContext<BuildContextFromWorkspace>;
+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/dist/pipeline/src/types/context.js

@@ -1,3 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.componentContextHasWorkspaceBuild = exports.componentContextIsStandaloneBuild = void 0;
+var componentContextIsStandaloneBuild = function (context) {
+    return context.build.type === "standalone";
+};
+exports.componentContextIsStandaloneBuild = componentContextIsStandaloneBuild;
+var componentContextHasWorkspaceBuild = function (context) {
+    return context.build.type === "fromWorkspace";
+};
+exports.componentContextHasWorkspaceBuild = componentContextHasWorkspaceBuild;
 //# sourceMappingURL=context.js.map

package/dist/pipeline/src/types/context.js.map

@@ -1 +1 @@
-{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../../pipeline/src/types/context.ts"],"names":[],"mappings":""}
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../../pipeline/src/types/context.ts"],"names":[],"mappings":";;;AA+LO,IAAM,iCAAiC,GAAG,UAC/C,OAAgD;IAEhD,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC;AAC7C,CAAC,CAAC;AAJW,QAAA,iCAAiC,qCAI5C;AAEK,IAAM,iCAAiC,GAAG,UAC/C,OAAgD;IAEhD,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,eAAe,CAAC;AAChD,CAAC,CAAC;AAJW,QAAA,iCAAiC,qCAI5C"}

package/dist/pipeline/src/types/environmentContext.d.ts

@@ -1,13 +1,12 @@
 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> = {
+export type EnvironmentContext<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;
     componentName: string;

package/dist/pipeline/src/types/jobs.d.ts

@@ -6,6 +6,10 @@ export type CatladderJobNeed = string | {
     job: string;
     artifacts: boolean;
     componentName?: string;
+} | {
+    job: string;
+    artifacts: boolean;
+    workspaceName: string;
 };
 export type CatladderJobEnvironmentConfig = {
     action?: GitlabEnvironment["action"];
@@ -38,6 +42,7 @@ export type CatladderJob<S = BaseStage> = {
     needsStages?: {
         stage: S;
         artifacts?: boolean;
+        workspaceName?: string;
     }[];
     /**
      * does this require another job (from the same component)?