@catladder/cli 1.144.1 → 1.145.0

package/dist/pipeline/src/pipeline/yarn/yarnUtils.js

@@ -0,0 +1,140 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getWorkspaceDependencies = exports.getWorkspaces = exports.getYarnVersion = void 0;
+var child_process_promise_1 = require("child-process-promise");
+var memoizee_1 = __importDefault(require("memoizee"));
+var execOrFail = function (cmd, onFail) { return __awaiter(void 0, void 0, void 0, function () {
+    var e_1;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                _a.trys.push([0, 2, , 3]);
+                return [4 /*yield*/, (0, child_process_promise_1.exec)(cmd).then(function (r) { return r.stdout; })];
+            case 1: return [2 /*return*/, _a.sent()];
+            case 2:
+                e_1 = _a.sent();
+                return [2 /*return*/, onFail !== null && onFail !== void 0 ? onFail : null];
+            case 3: return [2 /*return*/];
+        }
+    });
+}); };
+// export for mocking
+exports.getYarnVersion = (0, memoizee_1.default)(function () { return __awaiter(void 0, void 0, void 0, function () {
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0: return [4 /*yield*/, execOrFail("yarn --version", "")];
+            case 1: return [2 /*return*/, _a.sent()];
+        }
+    });
+}); }, { promise: true });
+// export for mocking
+exports.getWorkspaces = (0, memoizee_1.default)(function (isClassic) { return __awaiter(void 0, void 0, void 0, function () {
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+    var _l, _m;
+    return __generator(this, function (_o) {
+        switch (_o.label) {
+            case 0:
+                if (!isClassic) return [3 /*break*/, 2];
+                _c = (_b = Object).values;
+                _e = (_d = JSON).parse;
+                _g = (_f = JSON).parse;
+                return [4 /*yield*/, execOrFail("yarn workspaces --json info", "{}")];
+            case 1:
+                _a = _c.apply(_b, [_e.apply(_d, [(_m = (_l = _g.apply(_f, [_o.sent()])) === null || _l === void 0 ? void 0 : _l.data) !== null && _m !== void 0 ? _m : "{}"])]);
+                return [3 /*break*/, 4];
+            case 2:
+                _j = (_h = JSON).parse;
+                _k = "[".concat;
+                return [4 /*yield*/, execOrFail("yarn workspaces list --json --verbose", "")];
+            case 3:
+                _a = _j.apply(_h, [_k.apply("[", [(_o.sent())
+                            .trim()
+                            .split("\n")
+                            .join(","), "]"])]);
+                _o.label = 4;
+            case 4: return [2 /*return*/, _a];
+        }
+    });
+}); }, { promise: true });
+// recursivly get all workspace dependencies
+var getWorkspaceDependencies = function (ws, allWorkspaces) {
+    return ws
+        ? __spreadArray(__spreadArray([], __read(ws.workspaceDependencies), false), __read(ws.mismatchedWorkspaceDependencies), false).flatMap(function (location) {
+            // we have to do this recursivly
+            var otherWorkspace = allWorkspaces.find(function (w) { return w.location === location; });
+            if (otherWorkspace) {
+                return __spreadArray(__spreadArray([], __read((0, exports.getWorkspaceDependencies)(otherWorkspace, allWorkspaces)), false), [
+                    otherWorkspace.location,
+                ], false);
+            }
+            return [];
+        })
+            .filter(Boolean)
+        : [];
+};
+exports.getWorkspaceDependencies = getWorkspaceDependencies;
+//# sourceMappingURL=yarnUtils.js.map

package/dist/pipeline/src/pipeline/yarn/yarnUtils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"yarnUtils.js","sourceRoot":"","sources":["../../../../../../pipeline/src/pipeline/yarn/yarnUtils.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,+DAA6C;AAC7C,sDAAgC;AAGhC,IAAM,UAAU,GAAG,UAAO,GAAW,EAAE,MAAc;;;;;;gBAE1C,qBAAM,IAAA,4BAAI,EAAC,GAAG,CAAC,CAAC,IAAI,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,MAAM,EAAR,CAAQ,CAAC,EAAA;oBAA5C,sBAAO,SAAqC,EAAC;;;gBAE7C,sBAAO,MAAM,aAAN,MAAM,cAAN,MAAM,GAAI,IAAI,EAAC;;;;KAEzB,CAAC;AACF,qBAAqB;AACR,QAAA,cAAc,GAAG,IAAA,kBAAQ,EACpC;;;oBACS,qBAAM,UAAU,CAAC,gBAAgB,EAAE,EAAE,CAAC,EAAA;oBAA7C,sBAAO,SAAsC,EAAC;;;KAC/C,EACD,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB,CAAC;AACF,qBAAqB;AACR,QAAA,aAAa,GAAG,IAAA,kBAAQ,EACnC,UAAO,SAAkB;;;;;;qBAChB,SAAS,EAAT,wBAAS;gBACZ,KAAA,CAAA,KAAA,MAAM,CAAA,CAAC,MAAM,CAAA;gBACX,KAAA,CAAA,KAAA,IAAI,CAAA,CAAC,KAAK,CAAA;gBACR,KAAA,CAAA,KAAA,IAAI,CAAA,CAAC,KAAK,CAAA;gBAAC,qBAAM,UAAU,CAAC,6BAA6B,EAAE,IAAI,CAAC,EAAA;;gBAFpE,KAAA,cACE,cACE,MAAA,MAAA,cAAW,SAAqD,EAAC,0CAC7D,IAAI,mCAAI,IAAI,EACjB,EACF,CAAA;;;gBACD,KAAA,CAAA,KAAA,IAAI,CAAA,CAAC,KAAK,CAAA;;gBACH,qBAAM,UAAU,CAAC,uCAAuC,EAAE,EAAE,CAAC,EAAA;;gBADpE,KAAA,cACE,eAAI,CAAC,SAA6D,CAAC;6BAChE,IAAI,EAAE;6BACN,KAAK,CAAC,IAAI,CAAC;6BACX,IAAI,CAAC,GAAG,CAAC,OAAG,EAChB,CAAA;;oBAZL,0BAYM;;;KACP,EACD,EAAE,OAAO,EAAE,IAAI,EAAE,CAClB,CAAC;AAEF,4CAA4C;AACrC,IAAM,wBAAwB,GAAG,UACtC,EAAiB,EACjB,aAA8B;IAE9B,OAAO,EAAE;QACP,CAAC,CAAE,uCAAI,EAAE,CAAC,qBAAqB,kBAAK,EAAE,CAAC,+BAA+B,UACjE,OAAO,CAAC,UAAC,QAAQ;YAChB,gCAAgC;YAEhC,IAAM,cAAc,GAAG,aAAa,CAAC,IAAI,CACvC,UAAC,CAAC,IAAK,OAAA,CAAC,CAAC,QAAQ,KAAK,QAAQ,EAAvB,CAAuB,CAC/B,CAAC;YAEF,IAAI,cAAc,EAAE,CAAC;gBACnB,8CACK,IAAA,gCAAwB,EAAC,cAAc,EAAE,aAAa,CAAC;oBAC1D,cAAc,CAAC,QAAQ;0BACvB;YACJ,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC;aACD,MAAM,CAAC,OAAO,CAAc;QACjC,CAAC,CAAC,EAAE,CAAC;AACT,CAAC,CAAC;AAvBW,QAAA,wBAAwB,4BAuBnC"}

package/dist/pipeline/src/rules/index.d.ts

@@ -0,0 +1,11 @@
+import type { GitlabRule } from "../types";
+export declare const RULE_CONDITION_MAIN_BRANCH = "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH";
+export declare const RULE_IS_MAIN_BRANCH: GitlabRule;
+export declare const RULE_NEVER_ON_RELEASE_COMMIT: GitlabRule;
+export declare const RULE_NEVER_ON_SCHEDULE: GitlabRule;
+export declare const RULE_IS_MERGE_REQUEST: GitlabRule;
+export declare const RULE_IS_TAGGED_RELEASE: GitlabRule;
+export declare const RULES_ALWAYS: GitlabRule[];
+export declare const RULE_CONDITION_HOTFIX_BRANCH = "$CI_COMMIT_BRANCH =~ /^[0-9]+.([0-9]+|x).x$/";
+export declare const RULES_RELEASE: GitlabRule[];
+export declare const RULES_MANUAL_RELEASE: GitlabRule[];

package/dist/pipeline/src/rules/index.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RULES_MANUAL_RELEASE = exports.RULES_RELEASE = exports.RULE_CONDITION_HOTFIX_BRANCH = exports.RULES_ALWAYS = exports.RULE_IS_TAGGED_RELEASE = exports.RULE_IS_MERGE_REQUEST = exports.RULE_NEVER_ON_SCHEDULE = exports.RULE_NEVER_ON_RELEASE_COMMIT = exports.RULE_IS_MAIN_BRANCH = exports.RULE_CONDITION_MAIN_BRANCH = void 0;
+exports.RULE_CONDITION_MAIN_BRANCH = "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH";
+exports.RULE_IS_MAIN_BRANCH = {
+    if: exports.RULE_CONDITION_MAIN_BRANCH,
+};
+exports.RULE_NEVER_ON_RELEASE_COMMIT = {
+    if: "$CI_COMMIT_MESSAGE =~ /^chore\\(release\\).*/",
+    when: "never",
+};
+exports.RULE_NEVER_ON_SCHEDULE = {
+    if: '$CI_PIPELINE_SOURCE  == "schedule"',
+    when: "never",
+};
+exports.RULE_IS_MERGE_REQUEST = {
+    if: "$CI_MERGE_REQUEST_ID",
+};
+exports.RULE_IS_TAGGED_RELEASE = {
+    if: "$CI_COMMIT_TAG",
+};
+exports.RULES_ALWAYS = [
+    exports.RULE_IS_TAGGED_RELEASE,
+    exports.RULE_NEVER_ON_RELEASE_COMMIT,
+    exports.RULE_NEVER_ON_SCHEDULE,
+    {
+        if: "$CI_COMMIT_BRANCH =~ /^[0-9]+.([0-9]+|x).x$/",
+    },
+    {
+        if: "$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH",
+    },
+    exports.RULE_IS_MERGE_REQUEST,
+];
+exports.RULE_CONDITION_HOTFIX_BRANCH = "$CI_COMMIT_BRANCH =~ /^[0-9]+.([0-9]+|x).x$/";
+exports.RULES_RELEASE = [
+    exports.RULE_NEVER_ON_RELEASE_COMMIT,
+    exports.RULE_NEVER_ON_SCHEDULE,
+    {
+        if: exports.RULE_CONDITION_MAIN_BRANCH + ' && $AUTO_RELEASE == "true"',
+        when: "on_success",
+    },
+    {
+        if: exports.RULE_CONDITION_MAIN_BRANCH,
+        when: "manual",
+    },
+    {
+        if: exports.RULE_CONDITION_HOTFIX_BRANCH,
+        when: "manual",
+    },
+];
+exports.RULES_MANUAL_RELEASE = [
+    exports.RULE_NEVER_ON_RELEASE_COMMIT,
+    exports.RULE_NEVER_ON_SCHEDULE,
+    {
+        if: exports.RULE_CONDITION_MAIN_BRANCH,
+        when: "manual",
+    },
+    {
+        if: exports.RULE_CONDITION_HOTFIX_BRANCH,
+        when: "manual",
+    },
+];
+//# sourceMappingURL=index.js.map

package/dist/pipeline/src/rules/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../pipeline/src/rules/index.ts"],"names":[],"mappings":";;;AACa,QAAA,0BAA0B,GACrC,yCAAyC,CAAC;AAE/B,QAAA,mBAAmB,GAAe;IAC7C,EAAE,EAAE,kCAA0B;CAC/B,CAAC;AACW,QAAA,4BAA4B,GAAe;IACtD,EAAE,EAAE,+CAA+C;IACnD,IAAI,EAAE,OAAO;CACd,CAAC;AAEW,QAAA,sBAAsB,GAAe;IAChD,EAAE,EAAE,oCAAoC;IACxC,IAAI,EAAE,OAAO;CACd,CAAC;AAEW,QAAA,qBAAqB,GAAe;IAC/C,EAAE,EAAE,sBAAsB;CAC3B,CAAC;AAEW,QAAA,sBAAsB,GAAe;IAChD,EAAE,EAAE,gBAAgB;CACrB,CAAC;AAEW,QAAA,YAAY,GAAiB;IACxC,8BAAsB;IACtB,oCAA4B;IAC5B,8BAAsB;IACtB;QACE,EAAE,EAAE,8CAA8C;KACnD;IACD;QACE,EAAE,EAAE,yCAAyC;KAC9C;IACD,6BAAqB;CACtB,CAAC;AAEW,QAAA,4BAA4B,GACvC,8CAA8C,CAAC;AAEpC,QAAA,aAAa,GAAiB;IACzC,oCAA4B;IAC5B,8BAAsB;IACtB;QACE,EAAE,EAAE,kCAA0B,GAAG,6BAA6B;QAC9D,IAAI,EAAE,YAAY;KACnB;IACD;QACE,EAAE,EAAE,kCAA0B;QAC9B,IAAI,EAAE,QAAQ;KACf;IACD;QACE,EAAE,EAAE,oCAA4B;QAChC,IAAI,EAAE,QAAQ;KACf;CACF,CAAC;AAEW,QAAA,oBAAoB,GAAiB;IAChD,oCAA4B;IAC5B,8BAAsB;IACtB;QACE,EAAE,EAAE,kCAA0B;QAC9B,IAAI,EAAE,QAAQ;KACf;IACD;QACE,EAAE,EAAE,oCAA4B;QAChC,IAAI,EAAE,QAAQ;KACf;CACF,CAAC"}

package/dist/pipeline/src/runner/index.d.ts

@@ -0,0 +1,2 @@
+export type RunnerImageName = "jobs-default" | "jobs-meteor" | "jobs-testing-chrome" | "kubernetes" | "base-pipeline" | "docker-build" | "gcloud" | "semantic-release";
+export declare const getRunnerImage: (imageName: RunnerImageName) => string;

package/dist/pipeline/src/runner/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRunnerImage = void 0;
+var constants_1 = require("../constants");
+var getRunnerImage = function (imageName) {
+    return constants_1.DOCKER_REGISTRY + "/" + imageName + ":" + constants_1.PIPELINE_IMAGE_TAG;
+};
+exports.getRunnerImage = getRunnerImage;
+//# sourceMappingURL=index.js.map

package/dist/pipeline/src/runner/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../pipeline/src/runner/index.ts"],"names":[],"mappings":";;;AAAA,0CAAmE;AAW5D,IAAM,cAAc,GAAG,UAAC,SAA0B;IACvD,OAAA,2BAAe,GAAG,GAAG,GAAG,SAAS,GAAG,GAAG,GAAG,8BAAkB;AAA5D,CAA4D,CAAC;AADlD,QAAA,cAAc,kBACoC"}

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

@@ -0,0 +1,178 @@
+import type { BuildConfig } from "../build/types";
+import type { DeployConfig } from "../deploy/types";
+import type { CatladderJob } from "./jobs";
+import type { Context } from "./context";
+import type { PartialDeep } from "./utils";
+import type { PipelineType } from "..";
+export declare const ALL_PIPELINE_TRIGGERS: readonly ["mainBranch", "mr", "taggedRelease"];
+export type PipelineTrigger = typeof ALL_PIPELINE_TRIGGERS[number];
+/**
+ * all env types with their trigger.
+ * Each env type has a default env with the same name which is always included
+ */
+export declare const ENV_TYPES: {
+    readonly dev: {
+        readonly triggers: readonly ["mainBranch"];
+    };
+    readonly review: {
+        readonly triggers: readonly ["mr"];
+    };
+    readonly stage: {
+        readonly triggers: readonly ["taggedRelease"];
+    };
+    readonly prod: {
+        readonly triggers: readonly ["taggedRelease"];
+    };
+    readonly local: {
+        readonly triggers: readonly [];
+    };
+};
+/**
+ *
+ * @param trigger a trigger
+ * @returns array of env types for that trigger. this is also the list of default envs
+ */
+export declare const getEnvTypesByTrigger: (trigger: PipelineTrigger) => ("stage" | "dev" | "review" | "prod" | "local")[];
+export declare const DEFAULT_ENVS: string[];
+export declare const DEFAULT_ENV_TYPES: ("stage" | "dev" | "review" | "prod" | "local")[];
+export type EnvType = keyof typeof ENV_TYPES;
+export declare const isKnowEnvType: (env: string) => env is "stage" | "dev" | "review" | "prod" | "local";
+export type EnvVars = {
+    /**
+     * public env vars (means: they are checked in the repo).
+     *
+     * You can reuse env vars in other vars using ${OTHER_VAR}.
+     * You an reuse other public env vars, or secret env vars
+     *
+     * EXAMPLE: A_VAR: "the other var is ${OTHER_VAR}"
+     *
+     * You can reuse vars from other components in the same project using ${componentName:variableName}
+     * EXAMPLE: A_VAR: "the other var is ${api:OTHER_VAR}"
+     */
+    public?: Record<string, any>;
+    /**
+     * secret env vars. These vars can be managed with catladder/cli
+     */
+    secret?: string[];
+    /**
+     * @deprecated, use ${componentName:variableName} instead
+     *
+     * With fromComponents you can inject env vars from other components.
+     */
+    fromComponents?: {
+        [otherApp: string]: Record<string, string>;
+    };
+};
+export type DefaultEnvConfig = {
+    /**
+     * how the app is deployed
+     */
+    deploy: DeployConfig | false;
+    /**
+     * how the app is built and its runtime
+     */
+    build: BuildConfig;
+    /**
+     * environment variables
+     */
+    vars?: EnvVars;
+};
+export type DevLocalEnvConfig = {
+    vars?: EnvVars;
+    port?: number;
+};
+export type EnvConfig<E extends EnvType = EnvType> = {
+    /**
+     * type of the env (stage, prod, review, dev)
+     */
+    type?: E;
+    /**
+     * host that is used. If not set, a "canonical" url is created
+     */
+    host?: string;
+} & PartialDeep<DefaultEnvConfig>;
+export type EnvConfigWithComponent = EnvConfig<EnvType> & ComponentConfig;
+export type CustomEnv = EnvConfig & {
+    type: EnvType;
+};
+export type Env<C extends ConfigProps = never> = {
+    /**
+     * local is a special env that is only used in local development
+     */
+    local?: DevLocalEnvConfig;
+    dev?: EnvConfig<"dev"> | false;
+    stage?: EnvConfig<"stage"> | false;
+    review?: EnvConfig<"review"> | false;
+    prod?: EnvConfig<"prod"> | false;
+} & Record<C["CustomEnvs"], CustomEnv> & Record<string, any>;
+export type ComponentConfig<C extends ConfigProps = never> = {
+    /**
+     * specify environment configurations
+     */
+    env?: Env<C>;
+    /**
+     * the directory of the component (e.g. where the package.json or similar is located). You can set "." if you only have one app.
+     */
+    dir: string;
+    /**
+     * add custom jobs. Can be an array or a function that receives the context and returns an array of jobs.
+     * For convenience, all env vars are injectd as variables
+     *
+     * Please raise an issue on https://git.panter.ch/catladder/catladder
+     * to let us know about why you need to use custom jobs.
+     * This feedback will help us to generalize use cases
+     */
+    customJobs?: CatladderJob[] | ((context: Context) => CatladderJob[]);
+    /**
+     * whether to create a .env
+     *
+     * Be careful, this will overwrite any existing .env file!
+     *
+     * if set to true it will create .env locally and during build.
+     * Be careful: the .env file usually ends up in the build artifacts.
+     * Use this for apps and clients where env does not contain any secrets
+     *
+     *
+     * if set to "local" it will only create .env file locally.
+     * Use this in combination with @dotenvx/dotenvx or node 20 to start apps locally with .env files
+     * During build and runtime, it relies on the env vars set in the environment
+     *
+     */
+    dotEnv?: boolean | "local";
+    /**
+     * whether to create a env.d.ts localy and during build jobs
+     *
+     * Be careful, this will overwrite any existing env.d.ts file!
+     */
+    envDTs?: boolean;
+} & DefaultEnvConfig;
+export type ConfigProps = {
+    CustomEnvs: string;
+};
+export type Config<C extends ConfigProps = never> = {
+    pipelineType?: PipelineType;
+    /**
+     * name of the customer or group
+     */
+    customerName: string;
+    /**
+     * name of the app / project
+     */
+    appName: string;
+    /**
+     * if a env does not define a host, it will generate a canonical one (e.g. for review, dev and stage).
+     * This prop specifies the domain that is used for these urls.
+     *
+     */
+    domainCanonical?: string;
+    /**
+     * components (sub apps)
+     */
+    components: Record<string, ComponentConfig<C>>;
+    /**
+     * additional meta data (only for organisational purposes)
+     */
+    meta?: {
+        labels?: Record<string, string>;
+    };
+};

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

@@ -0,0 +1,69 @@
+"use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+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
+ */
+var getEnvTypesByTrigger = function (trigger) {
+    return Object.entries(exports.ENV_TYPES)
+        .filter(function (_a) {
+        var _b = __read(_a, 2), e = _b[1];
+        return e.triggers.includes(trigger);
+    })
+        .map(function (_a) {
+        var _b = __read(_a, 1), e = _b[0];
+        return e;
+    });
+};
+exports.getEnvTypesByTrigger = getEnvTypesByTrigger;
+exports.DEFAULT_ENVS = Object.keys(exports.ENV_TYPES);
+exports.DEFAULT_ENV_TYPES = exports.DEFAULT_ENVS;
+var isKnowEnvType = function (env) {
+    return env in exports.ENV_TYPES;
+};
+exports.isKnowEnvType = isKnowEnvType;
+//# sourceMappingURL=config.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../../../../pipeline/src/types/config.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;AAQa,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,IAAM,oBAAoB,GAAG,UAAC,OAAwB;IAC3D,OAAA,MAAM,CAAC,OAAO,CAAC,iBAAS,CAAC;SACtB,MAAM,CAAC,UAAC,EAAK;YAAL,KAAA,aAAK,EAAF,CAAC,QAAA;QACX,OAAC,CAAC,CAAC,QAAuC,CAAC,QAAQ,CAAC,OAAO,CAAC;IAA5D,CAA4D,CAC7D;SACA,GAAG,CAAC,UAAC,EAAG;YAAH,KAAA,aAAG,EAAF,CAAC,QAAA;QAAM,OAAA,CAAY;IAAZ,CAAY,CAAC;AAJ7B,CAI6B,CAAC;AALnB,QAAA,oBAAoB,wBAKD;AAEnB,QAAA,YAAY,GAAG,MAAM,CAAC,IAAI,CAAC,iBAAS,CAAC,CAAC;AACtC,QAAA,iBAAiB,GAAG,oBAAyB,CAAC;AAGpD,IAAM,aAAa,GAAG,UAAC,GAAW;IACvC,OAAO,GAAG,IAAI,iBAAS,CAAC;AAC1B,CAAC,CAAC;AAFW,QAAA,aAAa,iBAExB"}

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

@@ -0,0 +1,77 @@
+import type { StringOrBashExpression } from "../bash/BashExpression";
+import type { PredefinedVariables, SecretEnvVar } from "../context";
+import type { PipelineTrigger, ComponentConfig, Config, EnvType } 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> = {
+    envVars: V & UnspecifiedEnvVars;
+    secretEnvVarKeys: SecretEnvVar[];
+};
+export type EnvironmentEnvVarPart = {
+    host: StringOrBashExpression;
+    url: StringOrBashExpression;
+    /**
+     * vars that only are injected in certain jobs, but not elsewhere
+     */
+    jobOnlyVars: {
+        deploy: EnvironmentEnvVars;
+        build: EnvironmentEnvVars;
+    };
+} & EnvironmentEnvVars<PredefinedVariables>;
+export type Environment = {
+    host: StringOrBashExpression;
+    url: StringOrBashExpression;
+    /**
+     * the full name of the app. We use this as RELEASE_NAME in kubernetes and the service name in google cloud run
+     */
+    fullName: StringOrBashExpression;
+    shortName: string;
+    /**
+     * 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 YarnPackageManagerInfo = {
+    type: "yarn";
+    version: string;
+    workspaces: YarnWorkspace[];
+    currentWorkspace?: YarnWorkspace;
+    isClassic: boolean;
+    componentIsInWorkspace: boolean;
+    pathsToCopyInDocker: string[];
+    currentWorkspaceDependencies: string[];
+};
+export type PackageManagerInfo = YarnPackageManagerInfo;
+export type ContextBeforeConfig = {
+    componentName: string;
+    fullConfig: Config;
+    packageManagerInfo?: PackageManagerInfo;
+};
+export type Context = {
+    componentName: string;
+    componentConfig: ComponentConfig;
+    fullConfig: Config;
+    environment: Environment;
+    trigger?: PipelineTrigger;
+    pipelineType?: PipelineType;
+    packageManagerInfo?: PackageManagerInfo;
+};
+export type CatladderJobWithContext<S = BaseStage> = CatladderJob<S> & {
+    context: Context;
+};

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

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

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

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

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

@@ -0,0 +1,32 @@
+import type { StringOrBashExpression } from "../bash/BashExpression";
+import type { BuildConfigGeneric, BuildConfigType } from "../build";
+import type { DeployConfigGeneric } from "../deploy";
+import type { DeployConfigType } from "../deploy";
+import type { Config, EnvConfigWithComponent, EnvType } from "./config";
+import type { PipelineType } from "./pipeline";
+export type EnvironmentContext<B extends BuildConfigType, D extends DeployConfigType> = {
+    envConfigRaw: EnvConfigWithComponent;
+    buildConfigRaw: false | BuildConfigGeneric<B>;
+    deployConfigRaw: false | DeployConfigGeneric<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/pipeline/src/types/environmentContext.js

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

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

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