@catladder/cli 0.0.0-main-8dbb6c76 → 0.0.0-main-a6b45abe

package/dist/packages/pipeline/src/types/config.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isKnowEnvType = exports.DEFAULT_ENV_TYPES = exports.DEFAULT_ENVS = exports.getEnvTypesByTrigger = exports.ENV_TYPES = exports.ALL_PIPELINE_TRIGGERS = void 0;
+exports.ALL_PIPELINE_TRIGGERS = [
+    "mainBranch",
+    "mr",
+    "taggedRelease",
+];
+/**
+ * all env types with their trigger.
+ * Each env type has a default env with the same name which is always included
+ */
+exports.ENV_TYPES = {
+    dev: {
+        triggers: ["mainBranch"],
+    },
+    review: {
+        triggers: ["mr"],
+    },
+    stage: {
+        triggers: ["taggedRelease"],
+    },
+    prod: {
+        triggers: ["taggedRelease"],
+    },
+    local: {
+        triggers: [],
+    },
+};
+/**
+ *
+ * @param trigger a trigger
+ * @returns array of env types for that trigger. this is also the list of default envs
+ */
+const getEnvTypesByTrigger = (trigger) => Object.entries(exports.ENV_TYPES)
+    .filter(([, e]) => e.triggers.includes(trigger))
+    .map(([e]) => e);
+exports.getEnvTypesByTrigger = getEnvTypesByTrigger;
+exports.DEFAULT_ENVS = Object.keys(exports.ENV_TYPES);
+exports.DEFAULT_ENV_TYPES = exports.DEFAULT_ENVS;
+const isKnowEnvType = (env) => {
+    return env in exports.ENV_TYPES;
+};
+exports.isKnowEnvType = isKnowEnvType;
+//# sourceMappingURL=config.js.map

package/dist/packages/pipeline/src/types/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../../../packages/pipeline/src/types/config.ts"],"names":[],"mappings":";;;AAea,QAAA,qBAAqB,GAAG;IACnC,YAAY;IACZ,IAAI;IACJ,eAAe;CACP,CAAC;AAGX;;;GAGG;AACU,QAAA,SAAS,GAAG;IACvB,GAAG,EAAE;QACH,QAAQ,EAAE,CAAC,YAAY,CAAC;KACzB;IACD,MAAM,EAAE;QACN,QAAQ,EAAE,CAAC,IAAI,CAAC;KACjB;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,IAAI,EAAE;QACJ,QAAQ,EAAE,CAAC,eAAe,CAAC;KAC5B;IACD,KAAK,EAAE;QACL,QAAQ,EAAE,EAAE;KACb;CACO,CAAC;AAEX;;;;GAIG;AACI,MAAM,oBAAoB,GAAG,CAAC,OAAwB,EAAE,EAAE,CAC/D,MAAM,CAAC,OAAO,CAAC,iBAAS,CAAC;KACtB,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CACf,CAAC,CAAC,QAAuC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAC7D;KACA,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAY,CAAC,CAAC;AALnB,QAAA,oBAAoB,wBAKD;AAEnB,QAAA,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAS,CAAC,CAAC;AACtC,QAAA,iBAAiB,GAAG,oBAAyB,CAAC;AAGpD,MAAM,aAAa,GAAG,CAAC,GAAW,EAAkB,EAAE;IAC3D,OAAO,GAAG,IAAI,iBAAS,CAAC;AAC1B,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB"}

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

@@ -0,0 +1,166 @@
+import type { StringOrBashExpression } from "../../../bash/src/index.js";
+import type { BuildConfigFromWorkspace, BuildConfigStandalone, WorkspaceBuildConfig } from "../build";
+import type { PredefinedVariables, SecretEnvVar } from "../context";
+import type { DeployConfig } from "../deploy";
+import type { VariableValue } from "../../../bash/src/index.js";
+import type { ComponentConfig, Config, EnvType, PipelineTrigger } from "./config";
+import type { BaseStage, CatladderJob, CatladderJobSpec } from "./jobs";
+import type { PipelineType } from "./pipeline";
+export type UnspecifiedEnvVars = Record<string, VariableValue | undefined | null>;
+export type EnvironmentEnvVars<V extends UnspecifiedEnvVars = UnspecifiedEnvVars> = {
+    envVars: V & UnspecifiedEnvVars;
+    secretEnvVarKeys: SecretEnvVar[];
+};
+export type EnvironmentEnvVarPart = {
+    /**
+     * vars that only are injected in certain jobs, but not elsewhere
+     */
+    jobOnlyVars: {
+        deploy: EnvironmentEnvVars;
+        build: EnvironmentEnvVars;
+    };
+} & EnvironmentEnvVars<PredefinedVariables>;
+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;
+    /**
+     * the environment slug without component name.
+     */
+    slugPrefix: StringOrBashExpression;
+    /**
+     * the review slug, if it is a review app, null otherwise
+     */
+    reviewSlug: StringOrBashExpression | null;
+    /**
+     * the full environment slug, including the componentName
+     */
+    slug: StringOrBashExpression;
+    envType: EnvType;
+} & EnvironmentEnvVarPart;
+export type YarnWorkspace = {
+    name: string;
+    location: string;
+    workspaceDependencies: string[];
+    mismatchedWorkspaceDependencies: string[];
+};
+export type PackageManagerType = "yarn" | "pnpm";
+export type YarnPackageManagerInfoBase = {
+    type: "yarn";
+    version: string;
+    workspaces: YarnWorkspace[];
+    isClassic: boolean;
+};
+export type PnpmPackageManagerInfoBase = {
+    type: "pnpm";
+    version: string;
+    workspaces: YarnWorkspace[];
+};
+type PackageManagerInfoComponentPart = {
+    currentWorkspace?: YarnWorkspace;
+    componentIsInWorkspace: boolean;
+    pathsToCopyInDocker: string[];
+    currentWorkspaceDependencies: string[];
+};
+export type YarnPackageManagerInfoComponent = YarnPackageManagerInfoBase & PackageManagerInfoComponentPart;
+export type PnpmPackageManagerInfoComponent = PnpmPackageManagerInfoBase & PackageManagerInfoComponentPart;
+export type PackageManagerInfoComponent = YarnPackageManagerInfoComponent | PnpmPackageManagerInfoComponent;
+/**
+ * not confuse with yarn workspaces
+ */
+export type PackageManagerInfoBase = YarnPackageManagerInfoBase | PnpmPackageManagerInfoBase;
+export type ContextBeforeConfig = {
+    componentName: string;
+    fullConfig: Config;
+    packageManagerInfo?: Promise<PackageManagerInfoComponent>;
+};
+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") => Promise<string[]>;
+};
+export type BuildContextComponentBase = BuildContextBase;
+export type BuildContextStandalone<C extends BuildConfigStandalone = BuildConfigStandalone> = BuildContextComponentBase & {
+    config: C;
+    type: "standalone";
+    buildType: C["type"];
+};
+export type BuildContextDisabled = BuildContextComponentBase & {
+    type: "disabled";
+};
+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 BuildContextWithBuild = BuildContextStandalone | BuildContextFromWorkspace;
+export type BuildContextComponent = BuildContextWithBuild | BuildContextDisabled;
+export type BuildContext = BuildContextComponent | BuildContextWorkspace;
+export type DeployContext = {
+    config: DeployConfig;
+};
+export type ComponentContext<BC extends BuildContextComponent = BuildContextComponent> = {
+    type: "component";
+    env: string;
+    /**
+     * the name of the component
+     */
+    name: string;
+    /**
+     * the merged component config.
+     *
+     * use build.config and deploy.config instead if you need something from there
+     *
+     */
+    componentConfig: ComponentConfig;
+    build: BC;
+    deploy?: DeployContext | null;
+    fullConfig: Config;
+    environment: Environment;
+    trigger?: PipelineTrigger;
+    pipelineType?: PipelineType;
+    packageManagerInfo: Promise<PackageManagerInfoComponent>;
+    customJobs?: CatladderJobSpec[];
+};
+export type ComponentContextWithBuild = ComponentContext<BuildContextWithBuild>;
+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: Promise<PackageManagerInfoBase>;
+    components: Array<ComponentContext>;
+    build: BuildContextWorkspace;
+    trigger: PipelineTrigger;
+    pipelineType: PipelineType;
+    env: string;
+};
+export type { AgentContext } from "../pipeline/agent/createAgentContext";

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

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"context.js","sourceRoot":"","sources":["../../../../../../../packages/pipeline/src/types/context.ts"],"names":[],"mappings":";;;AAiNO,MAAM,iCAAiC,GAAG,CAC/C,OAAgD,EACK,EAAE;IACvD,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,CAAC;AAC7C,CAAC,CAAC;AAJW,QAAA,iCAAiC,qCAI5C;AAEK,MAAM,iCAAiC,GAAG,CAC/C,OAAgD,EACQ,EAAE;IAC1D,OAAO,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,eAAe,CAAC;AAChD,CAAC,CAAC;AAJW,QAAA,iCAAiC,qCAI5C"}

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

@@ -0,0 +1,31 @@
+import type { StringOrBashExpression } from "../../../bash/src/index.js";
+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 BuildConfig = BuildConfig, D extends DeployConfig = DeployConfig> = {
+    envConfigRaw: EnvConfigWithComponent;
+    buildConfigRaw: false | B;
+    deployConfigRaw: false | D;
+    env: string;
+    envType: EnvType;
+    componentName: string;
+    fullName: StringOrBashExpression;
+    /**
+     * the environment slug without component name.
+     */
+    environmentSlugPrefix: StringOrBashExpression;
+    /**
+     * the review slug, if it is a review app, null otherwise
+     */
+    reviewSlug: StringOrBashExpression | null;
+    /**
+     * the full environment slug, including the componentName
+     */
+    environmentSlug: StringOrBashExpression;
+    /**
+     * the full catladder config
+     */
+    fullConfig: Config;
+    pipelineType?: PipelineType;
+};

package/dist/packages/pipeline/src/types/environmentContext.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=environmentContext.js.map

package/dist/packages/pipeline/src/types/environmentContext.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"environmentContext.js","sourceRoot":"","sources":["../../../../../../../packages/pipeline/src/types/environmentContext.ts"],"names":[],"mappings":""}

package/dist/packages/pipeline/src/types/github-types.d.ts

@@ -0,0 +1,54 @@
+/**
+ * minimal model of the github actions workflow yaml,
+ * see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
+ */
+export type GithubStep = {
+    name?: string;
+    id?: string;
+    uses?: string;
+    run?: string;
+    with?: Record<string, unknown>;
+    env?: Record<string, string>;
+    if?: string;
+    shell?: string;
+};
+export type GithubService = {
+    image: string;
+    env?: Record<string, string>;
+    ports?: string[];
+    options?: string;
+};
+export type GithubJob = {
+    name?: string;
+    "runs-on": string;
+    needs?: string[];
+    container?: {
+        image: string;
+        credentials?: {
+            username: string;
+            password: string;
+        };
+    } | string;
+    services?: Record<string, GithubService>;
+    environment?: {
+        name: string;
+        url?: string;
+    } | string;
+    env?: Record<string, string>;
+    permissions?: Record<string, string>;
+    if?: string;
+    "continue-on-error"?: boolean;
+    outputs?: Record<string, string>;
+    steps: GithubStep[];
+};
+export type GithubWorkflow = {
+    name: string;
+    on: Record<string, unknown>;
+    permissions?: Record<string, string>;
+    concurrency?: {
+        group: string;
+        "cancel-in-progress"?: boolean;
+    };
+    env?: Record<string, string>;
+    jobs: Record<string, GithubJob>;
+};

package/dist/packages/pipeline/src/types/github-types.js

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * minimal model of the github actions workflow yaml,
+ * see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=github-types.js.map

package/dist/packages/pipeline/src/types/github-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"github-types.js","sourceRoot":"","sources":["../../../../../../../packages/pipeline/src/types/github-types.ts"],"names":[],"mappings":";AAAA;;;GAGG"}