@catladder/pipeline 0.0.0-node16-ddfae617 → 0.0.0-prettier-cbceeed9

package/dist/types/jobs.d.ts

@@ -1,6 +1,11 @@
-import { Artifacts, GitlabEnvironment, GitlabJobCache, GitlabRule, GitlabVariables, Service } from "./gitlab-types";
-export declare const BASE_STAGES: readonly ["setup", "test", "build", "deploy", "verify", "stop"];
+import type { Artifacts, GitlabEnvironment, GitlabJobCache, GitlabRule, GitlabVariables, GitlabJobService, GitlabJobImage } 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 | {
+  job: string;
+  artifacts: boolean;
+  componentName?: string;
+};
 export declare type CatladderJob<S = BaseStage> = {
   /**
    * the name of the job (without any env or app prefix and suffix)
@@ -12,64 +17,67 @@ export declare type CatladderJob<S = BaseStage> = {
    * - jobPerEnv: the job runs once per env
    * - stagePerEnv: the job runs once per env and is organized in its own stage. This mproves usability in gitlab, but works the same as `jobPerEnv`
    */
-
   envMode: "jobPerEnv" | "stagePerEnv" | "none";
   /**
    * the stage of the job
    */
-
   stage: S;
   /**
    * does this require another stage?
    */
-
   /**
    * script to run
    */
-
   script: (string | undefined)[];
   needsStages?: {
     stage: S;
     artifacts?: boolean;
   }[];
   /**
-   * does this require another job?
+   * does this require another job (from the same component)?
+   *
+   * You can also require a job from another component if you set `componentName`
+   *
    */
-
-  needs?: Array<string | {
+  needs?: Array<CatladderJobNeed>;
+  /**
+   * @deprecated set `componentName` to `needs` if you want to wait for a job from another component
+   */
+  needsOtherComponent?: Array<{
+    componentName: string;
     job: string;
     artifacts: boolean;
   }>;
   /**
    * cache config, we use here the same shape as gitlab itself
    */
-
   cache?: GitlabJobCache | GitlabJobCache[];
   /**
    * job artifacts, we also use gitlab shape here
    */
-
   artifacts?: Artifacts;
   /**
    * additional services, mainly used for docker
    */
-
-  services?: Service[];
+  services?: GitlabJobService[];
   /**
    * image to use
    */
-
-  image?: string;
+  image?: GitlabJobImage;
   /**
    * variables to pass
    */
-
   variables: GitlabVariables;
   /**
    * whether failures are allowed
    */
-
   allow_failure?: boolean;
   environment?: GitlabEnvironment;
   rules?: GitlabRule[];
+  /**
+   * How many instances of a job should be run in parallel.
+   * Useful for big test suites that can be split into multiple pipeline jobs.
+   * We use the same shape as GitLab itself.
+   */
+  parallel?: number;
 };

package/dist/types/jobs.js

@@ -2,4 +2,4 @@
 
 exports.__esModule = true;
 exports.BASE_STAGES = void 0;
-exports.BASE_STAGES = ["setup", "test", "build", "deploy", "verify", "stop"];
+exports.BASE_STAGES = ["setup", "test", "build", "deploy", "verify", "rollback", "stop"];

package/dist/types/pipeline.d.ts

@@ -1,4 +1,4 @@
-import { GitlabJobDef, GitlabPipeline } from "./gitlab-types";
+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;

package/dist/types/utils.d.ts

@@ -0,0 +1 @@
+export declare 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

@@ -0,0 +1,3 @@
+"use strict";
+
+exports.__esModule = true;

package/dist/utils/gitlab.d.ts

@@ -0,0 +1,5 @@
+export declare const allowFailureInScripts: (script: string[]) => string[];
+export declare const sanitizeForBashVariable: (name: string) => string;
+export declare const repeatOnFailure: (command: string, options: {
+  pauseInSeconds: number;
+}) => string;

package/dist/utils/gitlab.js

@@ -0,0 +1,48 @@
+"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;
+};
+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));
+};
+exports.__esModule = true;
+exports.repeatOnFailure = exports.sanitizeForBashVariable = exports.allowFailureInScripts = void 0;
+var allowFailureInScripts = function (script) {
+  return __spreadArray(__spreadArray(["set +e"], __read(script), false), ["set -e" // reenable
+  ], false);
+};
+exports.allowFailureInScripts = allowFailureInScripts;
+var sanitizeForBashVariable = function (name) {
+  return name.replace(/-/g, "_");
+};
+exports.sanitizeForBashVariable = sanitizeForBashVariable;
+var repeatOnFailure = function (command, options) {
+  return "\n    until ".concat(command, " &> /dev/null\n    do\n      echo \"Trying again.\"\n      sleep ").concat(options.pauseInSeconds, "\n    done\n  ");
+};
+exports.repeatOnFailure = repeatOnFailure;

package/dist/utils/index.js

@@ -4,10 +4,9 @@ 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;
-
+    r,
+    ar = [],
+    e;
   try {
     while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
   } catch (error) {
@@ -21,10 +20,8 @@ var __read = this && this.__read || function (o, n) {
       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)) {
@@ -34,28 +31,21 @@ var __spreadArray = this && this.__spreadArray || function (to, from, pack) {
   }
   return to.concat(ar || Array.prototype.slice.call(from));
 };
-
 exports.__esModule = true;
 exports.mergeWithMergingArrays = exports.ensureArray = exports.notNil = void 0;
-
 var lodash_1 = require("lodash");
-
 function notNil(value) {
   return value !== null && value !== undefined;
 }
-
 exports.notNil = notNil;
-
 var ensureArray = function (s) {
   return (0, lodash_1.isNil)(s) ? null : Array.isArray(s) ? s : [s];
 };
-
-exports.ensureArray = ensureArray; // see https://github.com/lodash/lodash/issues/5384
-
+exports.ensureArray = ensureArray;
+// see https://github.com/lodash/lodash/issues/5384
 var mergeWithMergingArrays = function (obj1, obj2) {
   return (0, lodash_1.mergeWith)({}, obj1, obj2, function (prop1, prop2) {
     return Array.isArray(prop1) && Array.isArray(prop2) ? __spreadArray(__spreadArray([], __read(prop1), false), __read(prop2), false) : undefined;
   });
 };
-
 exports.mergeWithMergingArrays = mergeWithMergingArrays;