@catladder/pipeline 1.144.1 → 1.145.0

package/dist/types/gitlab-ci-yml.d.ts

@@ -7,7 +7,7 @@
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "image".
  */
-export declare type Image = string | {
+export type Image = string | {
   /**
    * Full name of the image that should be used. It should contain the Registry part if needed.
    */
@@ -24,7 +24,7 @@ export declare type Image = string | {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "services".
  */
-export declare type Services = (string | {
+export type Services = (string | {
   /**
    * Full name of the image that should be used. It should contain the Registry part if needed.
    */
@@ -45,27 +45,27 @@ export declare type Services = (string | {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "before_script".
  */
-export declare type BeforeScript = (string | string[])[];
+export type BeforeScript = (string | string[])[];
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "after_script".
  */
-export declare type AfterScript = (string | string[])[];
+export type AfterScript = (string | string[])[];
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "!reference".
  */
-export declare type Reference = string[];
+export type Reference = string[];
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "interruptible".
  */
-export declare type Interruptible = boolean;
+export type Interruptible = boolean;
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "retry".
  */
-export declare type Retry = RetryMax | {
+export type Retry = RetryMax | {
   max?: RetryMax;
   when?: RetryErrors | RetryErrors[];
 };
@@ -75,27 +75,27 @@ export declare type Retry = RetryMax | {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "retry_max".
  */
-export declare type RetryMax = number;
+export type RetryMax = number;
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "retry_errors".
  */
-export declare type RetryErrors = "always" | "unknown_failure" | "script_failure" | "api_failure" | "stuck_or_timeout_failure" | "runner_system_failure" | "runner_unsupported" | "stale_schedule" | "job_execution_timeout" | "archived_failure" | "unmet_prerequisites" | "scheduler_failure" | "data_integrity_failure";
+export type RetryErrors = "always" | "unknown_failure" | "script_failure" | "api_failure" | "stuck_or_timeout_failure" | "runner_system_failure" | "runner_unsupported" | "stale_schedule" | "job_execution_timeout" | "archived_failure" | "unmet_prerequisites" | "scheduler_failure" | "data_integrity_failure";
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "tags".
  */
-export declare type Tags = (string | string[])[];
+export type Tags = (string | string[])[];
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "timeout".
  */
-export declare type Timeout = string;
+export type Timeout = string;
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "include_item".
  */
-export declare type IncludeItem = string | {
+export type IncludeItem = string | {
   /**
    * Relative path from local repository root (`/`) to the `yaml`/`yml` file template. The file must be on the same branch, and does not work across git submodules.
    */
@@ -140,7 +140,7 @@ export declare type IncludeItem = string | {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "includeRules".
  */
-export declare type IncludeRules = ({
+export type IncludeRules = ({
   if?: If;
   exists?: Exists;
   when?: ("never" | "always") | null;
@@ -149,13 +149,13 @@ export declare type IncludeRules = ({
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "if".
  */
-export declare type If = string;
+export type If = string;
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "exists".
  */
-export declare type Exists = string[];
-export declare type JobTemplate = {
+export type Exists = string[];
+export type JobTemplate = {
   image?: Image;
   services?: Services;
   before_script?: BeforeScript;
@@ -434,7 +434,7 @@ export declare type JobTemplate = {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "rules".
  */
-export declare type Rules = ({
+export type Rules = ({
   if?: If;
   changes?: Changes;
   exists?: Exists;
@@ -448,7 +448,7 @@ export declare type Rules = ({
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "changes".
  */
-export declare type Changes = {
+export type Changes = {
   /**
    * List of file paths.
    */
@@ -462,17 +462,17 @@ export declare type Changes = {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "when".
  */
-export declare type When = "on_success" | "on_failure" | "always" | "never" | "manual" | "delayed";
+export type When = "on_success" | "on_failure" | "always" | "never" | "manual" | "delayed";
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "start_in".
  */
-export declare type StartIn = string;
+export type StartIn = string;
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "allow_failure".
  */
-export declare type AllowFailure = boolean | {
+export type AllowFailure = boolean | {
   exit_codes: number;
 } | {
   /**
@@ -484,7 +484,7 @@ export declare type AllowFailure = boolean | {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "rulesNeeds".
  */
-export declare type RulesNeeds = (string | {
+export type RulesNeeds = (string | {
   /**
    * Name of a job that is defined in the pipeline.
    */
@@ -504,14 +504,14 @@ export declare type RulesNeeds = (string | {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "filter_refs".
  */
-export declare type FilterRefs = (("branches" | "tags" | "api" | "external" | "pipelines" | "pushes" | "schedules" | "triggers" | "web") | string)[];
+export type FilterRefs = (("branches" | "tags" | "api" | "external" | "pipelines" | "pushes" | "schedules" | "triggers" | "web") | string)[];
 /**
  * Use the `needs:parallel:matrix` keyword to specify parallelized jobs needed to be completed for the job to run. [Learn More](https://docs.gitlab.com/ee/ci/yaml/#needsparallelmatrix)
  *
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "parallel_matrix".
  */
-export declare type ParallelMatrix = {
+export type ParallelMatrix = {
   /**
    * Defines different variables for jobs that are running in parallel.
    *
@@ -527,7 +527,7 @@ export declare type ParallelMatrix = {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "parallel".
  */
-export declare type Parallel = number | {
+export type Parallel = number | {
   /**
    * Defines different variables for jobs that are running in parallel.
    *
@@ -541,7 +541,7 @@ export declare type Parallel = number | {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "job_template".
  */
-export declare type JobTemplate1 = {
+export type JobTemplate1 = {
   when: "delayed";
   [k: string]: any | undefined;
 } | {
@@ -554,17 +554,17 @@ export declare type JobTemplate1 = {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "workflowName".
  */
-export declare type WorkflowName = string;
+export type WorkflowName = string;
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "string_file_list".
  */
-export declare type StringFileList = string | string[];
+export type StringFileList = string | string[];
 /**
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "filter".
  */
-export declare type Filter = null | FilterRefs | {
+export type Filter = null | FilterRefs | {
   refs?: FilterRefs;
   /**
    * Filter job based on if Kubernetes integration is active.
@@ -580,7 +580,7 @@ export declare type Filter = null | FilterRefs | {
  * This interface was referenced by `HttpsGitlabComGitlabCiYml`'s JSON-Schema
  * via the `definition` "job".
  */
-export declare type Job = JobTemplate1;
+export type Job = JobTemplate1;
 export interface JobVariables {
   [k: string]: any | undefined;
 }

package/dist/types/gitlab-ci-yml.js

@@ -1,9 +1,10 @@
 "use strict";
 
-/* eslint-disable */
 /**
  * This file was automatically generated by json-schema-to-typescript.
  * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
  * and run json-schema-to-typescript to regenerate this file.
  */
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/types/gitlab-types.d.ts

@@ -1,11 +1,9 @@
 import type { Artifacts as GitlabCiArtifacts, JobTemplate, Cache, Rules } from "./gitlab-ci-yml";
 export { Retry, Image as GitlabJobImage } from "./gitlab-ci-yml";
-export interface Artifacts extends Omit<GitlabCiArtifacts, "paths"> {
-  paths: string[];
-}
-export declare type GitlabJobCache = Cache;
-export declare type GitlabRule = Exclude<Rules, null>[number];
-export declare type GitlabEnvironment = Omit<Exclude<JobTemplate["environment"], undefined | string>, "deployment_tier">;
+export type Artifacts = GitlabCiArtifacts;
+export type GitlabJobCache = Cache;
+export type GitlabRule = Exclude<Exclude<Rules, null>[number], string | string[]>;
+export type GitlabEnvironment = Omit<Exclude<JobTemplate["environment"], undefined | string>, "deployment_tier">;
 export interface GitlabJobDef extends Pick<JobTemplate, "after_script" | "allow_failure" | "artifacts" | "before_script" | "coverage" | "dependencies" | "environment" | "except" | "hooks" | "image" | "interruptible" | "needs" | "only" | "parallel" | "release" | "resource_group" | "retry" | "rules" | "script" | "services" | "stage" | "tags" | "trigger" | "variables"> {
   stage: JobTemplate["stage"];
   rules?: GitlabRule[];

package/dist/types/gitlab-types.js

@@ -1,3 +1,5 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/types/index.js

@@ -2,12 +2,16 @@
 
 var __createBinding = this && this.__createBinding || (Object.create ? function (o, m, k, k2) {
   if (k2 === undefined) k2 = k;
-  Object.defineProperty(o, k2, {
-    enumerable: true,
-    get: function () {
-      return m[k];
-    }
-  });
+  var desc = Object.getOwnPropertyDescriptor(m, k);
+  if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+    desc = {
+      enumerable: true,
+      get: function () {
+        return m[k];
+      }
+    };
+  }
+  Object.defineProperty(o, k2, desc);
 } : function (o, m, k, k2) {
   if (k2 === undefined) k2 = k;
   o[k2] = m[k];
@@ -15,7 +19,9 @@ var __createBinding = this && this.__createBinding || (Object.create ? function
 var __exportStar = this && this.__exportStar || function (m, exports) {
   for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 __exportStar(require("./config"), exports);
 __exportStar(require("./gitlab-types"), exports);
 __exportStar(require("./context"), exports);

package/dist/types/jobs.d.ts

@@ -1,12 +1,18 @@
-import type { Artifacts, GitlabEnvironment, GitlabJobCache, GitlabRule, GitlabJobImage, GitlabJobDef } from "./gitlab-types";
+import type { UnspecifiedEnvVars } from "..";
+import type { Artifacts, GitlabJobCache, GitlabRule, GitlabJobImage, GitlabJobDef, GitlabEnvironment } from "./gitlab-types";
 export declare const BASE_STAGES: readonly ["setup", "test", "build", "deploy", "verify", "rollback", "stop"];
-export declare type BaseStage = typeof BASE_STAGES[number];
-export declare type CatladderJobNeed = string | {
+export type BaseStage = typeof BASE_STAGES[number];
+export type CatladderJobNeed = string | {
   job: string;
   artifacts: boolean;
   componentName?: string;
 };
-export declare type CatladderJob<S = BaseStage> = {
+export type CatladderJobEnvironmentConfig = {
+  action?: GitlabEnvironment["action"];
+  on_stop?: GitlabEnvironment["on_stop"];
+  auto_stop_in?: string;
+};
+export type CatladderJob<S = BaseStage> = {
   /**
    * the name of the job (without any env or app prefix and suffix)
    */
@@ -67,12 +73,23 @@ export declare type CatladderJob<S = BaseStage> = {
   /**
    * variables to pass
    */
-  variables: GitlabJobDef["variables"];
+  variables: UnspecifiedEnvVars | undefined;
+  /**
+   * additional vars only for the runner.
+   * Also if you use services: that require env vars, you need to set them here.
+   *
+   */
+  runnerVariables?: Record<string, string>;
   /**
    * whether failures are allowed
    */
   allow_failure?: boolean;
-  environment?: GitlabEnvironment;
+  /**
+   * gitlab environment config, subject to change
+   */
+  environment?: CatladderJobEnvironmentConfig;
+  /** */
+  when?: GitlabRule["when"];
   rules?: GitlabRule[];
   /**
    * How many instances of a job should be run in parallel.

package/dist/types/jobs.js

@@ -1,5 +1,7 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.BASE_STAGES = void 0;
 exports.BASE_STAGES = ["setup", "test", "build", "deploy", "verify", "rollback", "stop"];

package/dist/types/pipeline.d.ts

@@ -1,4 +1,5 @@
 import type { GitlabJobDef, GitlabPipeline } from "./gitlab-types";
-export declare type PipelineType = "gitlab";
-export declare type PipelineJob<T extends PipelineType> = T extends "gitlab" ? GitlabJobDef : never;
-export declare type Pipeline<T extends PipelineType> = T extends "gitlab" ? GitlabPipeline : never;
+export type PipelineType = "gitlab";
+export type PipelineMode<T extends PipelineType> = T extends "gitlab" ? "childpipeline" | "local" : "local";
+export type PipelineJob<T extends PipelineType> = T extends "gitlab" ? GitlabJobDef : never;
+export type Pipeline<T extends PipelineType> = T extends "gitlab" ? GitlabPipeline : never;

package/dist/types/pipeline.js

@@ -1,3 +1,5 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/types/utils.d.ts

@@ -1 +1 @@
-export declare type PartialDeep<T> = T extends any[] ? T : T extends Record<string, any> ? { [P in keyof T]?: PartialDeep<T[P]> } : T;
+export type PartialDeep<T> = T extends any[] ? T : T extends Record<string, any> ? { [P in keyof T]?: PartialDeep<T[P]> } : T;

package/dist/types/utils.js

@@ -1,3 +1,5 @@
 "use strict";
 
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/dist/utils/gitlab.js

@@ -31,7 +31,9 @@ var __spreadArray = this && this.__spreadArray || function (to, from, pack) {
   }
   return to.concat(ar || Array.prototype.slice.call(from));
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.collapseableSection = exports.repeatOnFailure = exports.sanitizeForBashVariable = exports.allowFailureInScripts = void 0;
 var allowFailureInScripts = function (script) {
   return __spreadArray(__spreadArray(["set +e"], __read(script), false), ["set -e" // reenable

package/dist/utils/index.d.ts

@@ -1,3 +1,3 @@
 export declare function notNil<TValue>(value: TValue | null | undefined): value is TValue;
-export declare const ensureArray: <T>(s: T | T[] | undefined) => T[] | null;
+export declare const ensureArray: <T>(s: undefined | T | T[]) => T[] | null;
 export declare const mergeWithMergingArrays: <A, B>(obj1: A, obj2: B) => A & B;

package/dist/utils/index.js

@@ -31,7 +31,9 @@ var __spreadArray = this && this.__spreadArray || function (to, from, pack) {
   }
   return to.concat(ar || Array.prototype.slice.call(from));
 };
-exports.__esModule = true;
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
 exports.mergeWithMergingArrays = exports.ensureArray = exports.notNil = void 0;
 var lodash_1 = require("lodash");
 function notNil(value) {

package/dist/utils/writeFiles.d.ts

@@ -0,0 +1,7 @@
+export declare const getAutoGeneratedHeader: (commentChar: string) => string;
+export declare const writeGeneratedFile: (path: string, content: string, {
+  commentChar
+}: {
+  commentChar: string;
+}) => Promise<void>;
+export declare const writeYamlfile: (path: string, data: any) => Promise<void>;

package/dist/{pipeline/commitInfo/getBuildId.js → utils/writeFiles.js}

@@ -55,7 +55,7 @@ var __generator = this && this.__generator || function (thisArg, body) {
   }
   function step(op) {
     if (f) throw new TypeError("Generator is already executing.");
-    while (_) try {
+    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]) {
@@ -115,41 +115,58 @@ var __generator = this && this.__generator || function (thisArg, body) {
     };
   }
 };
-exports.__esModule = true;
-exports.getCurrentVersionString = exports.getBuildId = void 0;
-var child_process_promise_1 = require("child-process-promise");
-var getBuildId = function () {
-  return __awaiter(void 0, void 0, void 0, function () {
-    return __generator(this, function (_a) {
-      switch (_a.label) {
+var __importDefault = this && this.__importDefault || function (mod) {
+  return mod && mod.__esModule ? mod : {
+    "default": mod
+  };
+};
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.writeYamlfile = exports.writeGeneratedFile = exports.getAutoGeneratedHeader = void 0;
+var promises_1 = require("fs/promises");
+var yaml_1 = require("yaml");
+var packageInfos_1 = __importDefault(require("../packageInfos"));
+var getAutoGeneratedHeader = function (commentChar) {
+  return ["-------------------------------------------------", "\uD83D\uDC31 \uD83D\uDD28 This file is generated by catladder v".concat(packageInfos_1.default.version), "\uD83D\uDEA8 Do not edit this file manually \uD83D\uDEA8", "-------------------------------------------------"].map(function (line) {
+    return "".concat(commentChar, " ").concat(line);
+  }).join("\n").concat("\n");
+};
+exports.getAutoGeneratedHeader = getAutoGeneratedHeader;
+var writeGeneratedFile = function (path_1, content_1, _a) {
+  return __awaiter(void 0, [path_1, content_1, _a], void 0, function (path, content, _b) {
+    var commentChar = _b.commentChar;
+    return __generator(this, function (_c) {
+      switch (_c.label) {
         case 0:
-          return [4 /*yield*/, (0, child_process_promise_1.exec)("git describe --tags || git rev-parse HEAD").then(function (s) {
-            return s.stdout.trim();
+          return [4 /*yield*/, (0, promises_1.writeFile)(path,
+          // need to spread out the jobs, forgot why
+          [(0, exports.getAutoGeneratedHeader)(commentChar), content].join("\n"), {
+            encoding: "utf-8"
           })];
         case 1:
-          return [2 /*return*/, _a.sent()];
+          _c.sent();
+          return [2 /*return*/];
       }
     });
   });
 };
-exports.getBuildId = getBuildId;
-// thx chat gpt
-/**
- * returns the last tagged version string Major.minor.patch
- * returns 0.0.0 if there is no tag
- */
-var getCurrentVersionString = function () {
+
+exports.writeGeneratedFile = writeGeneratedFile;
+var writeYamlfile = function (path, data) {
   return __awaiter(void 0, void 0, void 0, function () {
     return __generator(this, function (_a) {
       switch (_a.label) {
         case 0:
-          return [4 /*yield*/, (0, child_process_promise_1.exec)('latest_tag=$(git describe --tags --abbrev=0 2>/dev/null); if [ -z "$latest_tag" ]; then echo "0.0.0"; else echo "${latest_tag#v}"; fi | cut -d "." -f 1-3').then(function (s) {
-            return s.stdout.trim();
+          return [4 /*yield*/, (0, exports.writeGeneratedFile)(path, (0, yaml_1.stringify)(data), {
+            commentChar: "#"
           })];
         case 1:
-          return [2 /*return*/, _a.sent()];
+          _a.sent();
+          return [2 /*return*/];
       }
     });
   });
 };
-exports.getCurrentVersionString = getCurrentVersionString;
+
+exports.writeYamlfile = writeYamlfile;