@catladder/pipeline 2.0.5 → 2.1.0

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "2.0.5",
+  "version": "2.1.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables",
@@ -69,28 +69,27 @@
   "main": "dist/index.js",
   "sideEffects": false,
   "devDependencies": {
-    "@babel/cli": "^7.16.0",
-    "@babel/core": "^7.0.0-0",
-    "@babel/plugin-syntax-typescript": "^7.16.7",
-    "@babel/preset-typescript": "^7.16.5",
-    "@jest/globals": "^29.3.1",
-    "@types/child-process-promise": "^2.2.2",
-    "@types/jest": "^27.4.0",
-    "@types/lodash": "^4.14.185",
-    "@types/node": "^20.14.2",
+    "@babel/cli": "^7.24.8",
+    "@babel/core": "^7.25.2",
+    "@babel/plugin-syntax-typescript": "^7.25.4",
+    "@babel/preset-typescript": "^7.24.7",
+    "@jest/globals": "^29.7.0",
+    "@types/child-process-promise": "^2.2.6",
+    "@types/jest": "^29.5.12",
+    "@types/lodash": "^4.17.7",
+    "@types/node": "^22.5.1",
     "babel-plugin-transform-inline-environment-variables": "^0.4.3",
     "child-process-promise": "^2.2.1",
-    "glob": "^10.4.2",
+    "glob": "^11.0.0",
     "json-schema-to-typescript": "^13.0.2",
     "lodash": "^4.17.21",
-    "memoizee": "^0.4.15",
-    "path-equal": "1.1.3",
-    "slugify": "^1.6.3",
-    "tsx": "^4.16.2",
+    "memoizee": "^0.4.17",
+    "path-equal": "1.2.5",
+    "slugify": "^1.6.6",
     "typescript": "^5.4.5",
-    "yaml": "^2.4.5"
+    "yaml": "^2.5.0"
   },
   "dependencies": {
-    "tsx": "^4.16.2"
+    "tsx": "^4.19.0"
   }
 }

package/src/build/cache/createJobCache.ts

@@ -30,7 +30,7 @@ export const createJobCacheFromCacheConfigs = (
                 const baseDir =
                   c.pathMode === "absolute"
                     ? ""
-                    : c.baseDir ?? context.build.dir;
+                    : (c.baseDir ?? context.build.dir);
                 return join(baseDir, p);
               }),
             ),
@@ -41,7 +41,7 @@ export const createJobCacheFromCacheConfigs = (
   const advancedCaches = advancedCacheDefs.map(
     ({ key, paths, policy, scope, pathMode, buildDir, ...rest }) => {
       const baseDir =
-        pathMode === "absolute" ? "" : buildDir ?? context.build.dir;
+        pathMode === "absolute" ? "" : (buildDir ?? context.build.dir);
       const transformedKey =
         scope === "global"
           ? key

package/src/build/sbom.ts

@@ -22,14 +22,14 @@ export const createSbomBuildJob = (context: ComponentContext): CatladderJob => {
     isStandaloneBuildConfig(buildConfig) &&
     buildConfig.type === "custom" &&
     buildConfig.sbom !== false
-      ? buildConfig.sbom?.jobImage ?? defaultImage
+      ? (buildConfig.sbom?.jobImage ?? defaultImage)
       : defaultImage;
 
   const script =
     isStandaloneBuildConfig(buildConfig) &&
     buildConfig.type === "custom" &&
     buildConfig.sbom !== false
-      ? ensureArrayOrNull(buildConfig.sbom?.command) ?? defaultScript
+      ? (ensureArrayOrNull(buildConfig.sbom?.command) ?? defaultScript)
       : defaultScript;
 
   return {

package/src/catladder-gitlab.ts

@@ -1,17 +1,10 @@
 import { readConfig } from "./config";
 import { generatePipelineFiles } from "./pipeline/generatePipelineFiles";
-import type { PipelineMode } from "./types";
 
-const mode = process.argv[2] || "local";
-
-const config = readConfig().then(async (result) => {
+readConfig().then(async (result) => {
   if (!result?.config) {
     throw new Error("no catladder config found");
   }
 
-  await generatePipelineFiles(
-    result.config,
-    "gitlab",
-    mode as PipelineMode<"gitlab">,
-  );
+  await generatePipelineFiles(result.config, "gitlab");
 });

package/src/config/readConfig.ts

@@ -1,6 +1,5 @@
 import { existsSync, readFileSync } from "fs";
 
-// eslint-disable-next-line @typescript-eslint/no-var-requires
 const tsx = require("tsx/cjs/api");
 
 import { parse } from "yaml";

package/src/context/createComponentContext.ts

@@ -76,7 +76,7 @@ export const createComponentContext = async (
     dir,
     // also copy workspace dependencies in monorepo if packages are shared and they create build artifacts
     ...(mode === "all"
-      ? packageManagerInfo.currentWorkspaceDependencies ?? []
+      ? (packageManagerInfo.currentWorkspaceDependencies ?? [])
       : []),
   ];
   const _getBuildContext = (): BuildContextComponent => {

package/src/context/getEnvironmentVariables.ts

@@ -134,7 +134,7 @@ export const getEnvironmentVariables = async (
   );
 
   const publicEnvVars =
-    options.shouldResolveReferences ?? true
+    (options.shouldResolveReferences ?? true)
       ? await resolveAllReferences(
           publicEnvVarsUnresolved,
           async (otherComponentName) => {

package/src/deploy/base/deploy.ts

@@ -62,11 +62,11 @@ export const createDeployJob = (
         ? []
         : [{ job: SBOM_BUILD_JOB_NAME, artifacts: true }]),
       ...(deployConfig
-        ? deployConfig.waitFor?.map((c) => ({
+        ? (deployConfig.waitFor?.map((c) => ({
             componentName: c,
             job: DEPLOY_JOB_NAME,
             artifacts: false,
-          })) ?? []
+          })) ?? [])
         : []),
     ],
     // we don't want to deploy when there is a broken test
@@ -117,7 +117,7 @@ export const createDeployJob = (
     runnerVariables: {
       ...DEPLOY_RUNNER_VARIABLES,
       ...(jobDefinition.runnerVariables ?? {}),
-      ...(deployConfig ? deployConfig.runnerVariables ?? {} : {}),
+      ...(deployConfig ? (deployConfig.runnerVariables ?? {}) : {}),
     },
     environment: isStoppable
       ? {

package/src/deploy/cloudRun/createJobs/cloudRunServices.ts

@@ -25,7 +25,7 @@ export const getServiceDeployScript = (
   const customConfig = service !== true ? service : undefined;
   const command =
     service !== true
-      ? service?.command ?? context.build.config.startCommand
+      ? (service?.command ?? context.build.config.startCommand)
       : undefined;
 
   const commandArray = command

package/src/pipeline/generatePipelineFiles.ts

@@ -1,36 +1,8 @@
-import type { Config, PipelineMode, PipelineType } from "../types";
+import type { Config, PipelineType } from "../types";
 import { writeYamlfile } from "../utils/writeFiles";
-import { createChildPipeline } from "./createChildPipeline";
 import { createMainPipeline } from "./createMainPipeline";
-import { getPipelineTriggerForGitlabChildPipeline } from "./gitlab/getPipelineTriggerForGitlabChildPipeline";
 import { sortGitLabJobDefProps } from "./gitlab/sortGitLabJobDefProps";
 
-export async function generateChildPipelineContent<T extends PipelineType>(
-  config: Config,
-  pipelineType: T,
-) {
-  const trigger = getPipelineTriggerForGitlabChildPipeline();
-  const { jobs, image, stages, variables, workflow, ...pipelineRest } =
-    await createChildPipeline(pipelineType, trigger, config);
-
-  const jobsWithSortedProps = Object.fromEntries(
-    Object.entries(jobs).map(([jobName, job]) => [
-      jobName,
-      sortGitLabJobDefProps(job),
-    ]),
-  );
-
-  return {
-    image,
-    stages,
-    variables,
-    workflow,
-    ...pipelineRest,
-    // jobs need to be spread into main YAML, because GitLab pipeline YAML has no jobs key - jobs are top level with their key as their name
-    ...jobsWithSortedProps,
-  };
-}
-
 export async function generateLocalPipelineContent<T extends PipelineType>(
   config: Config,
   pipelineType: T,
@@ -59,15 +31,7 @@ export async function generateLocalPipelineContent<T extends PipelineType>(
 export async function generatePipelineFiles<T extends PipelineType>(
   config: Config,
   pipelineType: T,
-  mode: PipelineMode<T>,
 ) {
-  if (mode === "childpipeline") {
-    const pipelineContent = await generateChildPipelineContent(
-      config,
-      pipelineType,
-    );
-    return writeYamlfile(`__pipeline.yml`, pipelineContent);
-  }
   const pipelineContent = await generateLocalPipelineContent(
     config,
     pipelineType,

package/src/pipeline/gitlab/gitlabReleaseJobs.ts

@@ -9,15 +9,13 @@ export const getGitlabReleaseJobs = () => {
     ["create release"]: {
       stage: "release",
       image: getRunnerImage("semantic-release"),
-      script: ["semanticRelease"],
-      after_script: [EXPIRED_TOKEN_HELP],
+      script: ["semanticRelease", EXPIRED_TOKEN_HELP],
       rules: RULES_RELEASE,
     },
     ["⚠️ force create release"]: {
       stage: "release",
       image: getRunnerImage("semantic-release"),
-      script: ["semanticRelease"],
-      after_script: [EXPIRED_TOKEN_HELP],
+      script: ["semanticRelease", EXPIRED_TOKEN_HELP],
       needs: [],
       rules: RULES_MANUAL_RELEASE,
     },

package/src/pipeline/index.ts

@@ -1,4 +1,3 @@
-export * from "./createChildPipeline";
 export * from "./createJobsForComponent";
 export * from "./generatePipelineFiles";
 export * from "./gitlab/gitlabReleaseJobs";

package/src/types/pipeline.ts

@@ -2,10 +2,6 @@ import type { GitlabJobDef, GitlabPipeline } from "./gitlab-types";
 
 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;

package/dist/pipeline/createChildPipeline.d.ts

@@ -1,3 +0,0 @@
-import type { Pipeline } from "../types";
-import type { Config, PipelineTrigger } from "../types/config";
-export declare const createChildPipeline: <T extends "gitlab">(pipelineType: T, trigger: PipelineTrigger, config: Config) => Promise<Pipeline<T>>;

package/dist/pipeline/createChildPipeline.js

@@ -1,163 +0,0 @@
-"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
-    };
-  }
-};
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.createChildPipeline = void 0;
-var rules_1 = require("../rules");
-var createAllJobs_1 = require("./createAllJobs");
-var getPipelineStages_1 = require("./getPipelineStages");
-var createGitlabJobs_1 = require("./gitlab/createGitlabJobs");
-var createGitlabPipeline_1 = require("./gitlab/createGitlabPipeline");
-var createChildPipeline = function (pipelineType, trigger, config) {
-  return __awaiter(void 0, void 0, void 0, function () {
-    var jobs, stages, gitlabJobs;
-    return __generator(this, function (_a) {
-      switch (_a.label) {
-        case 0:
-          return [4 /*yield*/, (0, createAllJobs_1.createAllJobs)({
-            config: config,
-            trigger: trigger,
-            pipelineType: pipelineType
-          })];
-        case 1:
-          jobs = _a.sent();
-          stages = (0, getPipelineStages_1.getPipelineStages)(config);
-          if (!(pipelineType === "gitlab")) return [3 /*break*/, 3];
-          return [4 /*yield*/, (0, createGitlabJobs_1.createGitlabJobs)(jobs)];
-        case 2:
-          gitlabJobs = _a.sent();
-          return [2 /*return*/, (0, createGitlabPipeline_1.createGitlabPipelineWithDefaults)({
-            workflow: {
-              rules: rules_1.RULES_ALWAYS
-            },
-            stages: stages,
-            jobs: Object.fromEntries(gitlabJobs.map(function (_a) {
-              var gitlabJob = _a.gitlabJob,
-                name = _a.name;
-              return [name, gitlabJob];
-            })),
-            variables: config.runnerVariables
-          })];
-        case 3:
-          throw new Error("".concat(pipelineType, " is not supported"));
-      }
-    });
-  });
-};
-exports.createChildPipeline = createChildPipeline;

package/dist/pipeline/gitlab/getPipelineTriggerForGitlabChildPipeline.d.ts

@@ -1 +0,0 @@
-export declare function getPipelineTriggerForGitlabChildPipeline(): "mainBranch" | "mr" | "taggedRelease";

package/dist/pipeline/gitlab/getPipelineTriggerForGitlabChildPipeline.js

@@ -1,29 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.getPipelineTriggerForGitlabChildPipeline = void 0;
-var constants_1 = require("../../constants");
-function getPipelineTriggerForGitlabChildPipeline() {
-  var _a = process.env,
-    CI_MERGE_REQUEST_ID = _a.CI_MERGE_REQUEST_ID,
-    CI_COMMIT_TAG = _a.CI_COMMIT_TAG,
-    CI_COMMIT_BRANCH = _a.CI_COMMIT_BRANCH,
-    CI_DEFAULT_BRANCH = _a.CI_DEFAULT_BRANCH;
-  var isDefaultBranch = Boolean(CI_DEFAULT_BRANCH) && CI_COMMIT_BRANCH === CI_DEFAULT_BRANCH;
-  var isHotfixBranch = CI_COMMIT_BRANCH ? /^[0-9]+\.([0-9]+|x)\.x$/.test(CI_COMMIT_BRANCH) : false;
-  var isMergeRequest = Boolean(CI_MERGE_REQUEST_ID);
-  var isTaggedRelease = Boolean(CI_COMMIT_TAG);
-  console.info("catladder version ".concat(constants_1.PIPELINE_IMAGE_TAG));
-  var trigger = isMergeRequest || isHotfixBranch ? "mr" : isDefaultBranch ? "mainBranch" : isTaggedRelease ? "taggedRelease" : null;
-  if (!trigger) {
-    throw new Error("no matching trigger: " + JSON.stringify({
-      isMergeRequest: isMergeRequest,
-      isDefaultBranch: isDefaultBranch,
-      isTaggedRelease: isTaggedRelease
-    }, null, 2));
-  }
-  return trigger;
-}
-exports.getPipelineTriggerForGitlabChildPipeline = getPipelineTriggerForGitlabChildPipeline;

package/src/pipeline/createChildPipeline.ts

@@ -1,37 +0,0 @@
-import { RULES_ALWAYS } from "../rules";
-
-import type { Pipeline, PipelineType } from "../types";
-import type { Config, PipelineTrigger } from "../types/config";
-import { createAllJobs } from "./createAllJobs";
-import { getPipelineStages } from "./getPipelineStages";
-import { createGitlabJobs } from "./gitlab/createGitlabJobs";
-import { createGitlabPipelineWithDefaults } from "./gitlab/createGitlabPipeline";
-
-export const createChildPipeline = async <T extends PipelineType>(
-  pipelineType: T,
-  trigger: PipelineTrigger,
-  config: Config,
-): Promise<Pipeline<T>> => {
-  const jobs = await createAllJobs({
-    config,
-    trigger,
-    pipelineType,
-  });
-
-  const stages = getPipelineStages(config);
-
-  if (pipelineType === "gitlab") {
-    const gitlabJobs = await createGitlabJobs(jobs);
-    return createGitlabPipelineWithDefaults({
-      workflow: {
-        rules: RULES_ALWAYS,
-      },
-      stages,
-      jobs: Object.fromEntries(
-        gitlabJobs.map(({ gitlabJob, name }) => [name, gitlabJob]),
-      ),
-      variables: config.runnerVariables,
-    }) as Pipeline<T>;
-  }
-  throw new Error(`${pipelineType} is not supported`);
-};

package/src/pipeline/gitlab/getPipelineTriggerForGitlabChildPipeline.ts

@@ -1,46 +0,0 @@
-import type { PipelineTrigger } from "../..";
-import { PIPELINE_IMAGE_TAG } from "../../constants";
-
-export function getPipelineTriggerForGitlabChildPipeline() {
-  const {
-    CI_MERGE_REQUEST_ID,
-    CI_COMMIT_TAG,
-    CI_COMMIT_BRANCH,
-    CI_DEFAULT_BRANCH,
-  } = process.env;
-
-  const isDefaultBranch =
-    Boolean(CI_DEFAULT_BRANCH) && CI_COMMIT_BRANCH === CI_DEFAULT_BRANCH;
-  const isHotfixBranch = CI_COMMIT_BRANCH
-    ? /^[0-9]+\.([0-9]+|x)\.x$/.test(CI_COMMIT_BRANCH)
-    : false;
-  const isMergeRequest = Boolean(CI_MERGE_REQUEST_ID);
-  const isTaggedRelease = Boolean(CI_COMMIT_TAG);
-
-  console.info(`catladder version ${PIPELINE_IMAGE_TAG}`);
-
-  const trigger: PipelineTrigger | null =
-    isMergeRequest || isHotfixBranch
-      ? "mr"
-      : isDefaultBranch
-        ? "mainBranch"
-        : isTaggedRelease
-          ? "taggedRelease"
-          : null;
-
-  if (!trigger) {
-    throw new Error(
-      "no matching trigger: " +
-        JSON.stringify(
-          {
-            isMergeRequest,
-            isDefaultBranch,
-            isTaggedRelease,
-          },
-          null,
-          2,
-        ),
-    );
-  }
-  return trigger;
-}