@catladder/pipeline 1.162.0 → 1.163.1

package/examples/node-build-with-custom-image.test.ts

@@ -1,10 +1,18 @@
-import { createAllPipelines } from "./__utils__/helpers";
+import {
+  createAllPipelines,
+  createYamlLocalPipeline,
+} from "./__utils__/helpers";
 import config from "./node-build-with-custom-image";
 
 /**
  * This test is auto-generated.
  * Modifications will be overwritten on every `yarn test` run!
  */
+
 it("matches snapshot for node-build-with-custom-image", async () => {
   expect(await createAllPipelines(config)).toMatchSnapshot();
 });
+
+it("matches snapshot for cloud-run-memory-limit local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/examples/node-build-with-docker-additions.test.ts

@@ -1,10 +1,18 @@
-import { createAllPipelines } from "./__utils__/helpers";
+import {
+  createAllPipelines,
+  createYamlLocalPipeline,
+} from "./__utils__/helpers";
 import config from "./node-build-with-docker-additions";
 
 /**
  * This test is auto-generated.
  * Modifications will be overwritten on every `yarn test` run!
  */
+
 it("matches snapshot for node-build-with-docker-additions", async () => {
   expect(await createAllPipelines(config)).toMatchSnapshot();
 });
+
+it("matches snapshot for cloud-run-memory-limit local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/examples/rails-k8s-with-worker.test.ts

@@ -1,10 +1,18 @@
-import { createAllPipelines } from "./__utils__/helpers";
+import {
+  createAllPipelines,
+  createYamlLocalPipeline,
+} from "./__utils__/helpers";
 import config from "./rails-k8s-with-worker";
 
 /**
  * This test is auto-generated.
  * Modifications will be overwritten on every `yarn test` run!
  */
+
 it("matches snapshot for rails-k8s-with-worker", async () => {
   expect(await createAllPipelines(config)).toMatchSnapshot();
 });
+
+it("matches snapshot for cloud-run-memory-limit local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/examples/wait-for-other-deploy.test.ts

@@ -1,10 +1,18 @@
-import { createAllPipelines } from "./__utils__/helpers";
+import {
+  createAllPipelines,
+  createYamlLocalPipeline,
+} from "./__utils__/helpers";
 import config from "./wait-for-other-deploy";
 
 /**
  * This test is auto-generated.
  * Modifications will be overwritten on every `yarn test` run!
  */
+
 it("matches snapshot for wait-for-other-deploy", async () => {
   expect(await createAllPipelines(config)).toMatchSnapshot();
 });
+
+it("matches snapshot for cloud-run-memory-limit local pipeline YAML", async () => {
+  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();
+});

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@catladder/pipeline",
-  "description": "CI/CD and Devops-Workflow",
-  "homepage": "https://git.panter.ch/catladder/catladder/#readme",
+  "description": "Panter workflow for cloud CI/CD and DevOps",
+  "homepage": "https://catladder.git.panter.biz/catladder/docs",
   "bugs": "https://git.panter.ch/catladder/catladder/issues",
+  "readme": "https://git.panter.ch/catladder/catladder/-/blob/main/pipeline/README.md",
   "repository": {
     "type": "git",
     "url": "git+https://git.panter.ch/catladder/catladder.git",
@@ -52,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "1.162.0",
+  "version": "1.163.1",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables && yarn build:bundle",

package/scripts/generate-examples-test.ts

@@ -63,16 +63,18 @@ async function main() {
     exampleFiles.map(async (exampleFile) => {
       const kebabName = basename(exampleFile, ".ts");
       const testFileContent = [
-        `import { createAllPipelines } from "./__utils__/helpers";`,
+        `import { createAllPipelines, createYamlLocalPipeline } from "./__utils__/helpers";`,
         `import config from "./${kebabName}";`,
-        ``,
-        `/**`,
+        `\n/**`,
         ` * This test is auto-generated.`,
         ` * Modifications will be overwritten on every \`yarn test\` run!`,
-        ` */`,
+        ` */\n`,
         `it("matches snapshot for ${kebabName}", async () => {`,
         `  expect(await createAllPipelines(config)).toMatchSnapshot();`,
-        `});`,
+        `});\n`,
+        `it("matches snapshot for cloud-run-memory-limit local pipeline YAML", async () => {`,
+        `  expect(await createYamlLocalPipeline(config)).toMatchSnapshot();`,
+        `});\n`,
       ].join("\n");
       const formattedTest = await format(testFileContent, {
         parser: "typescript",

package/src/build/types.ts

@@ -114,6 +114,9 @@ export type BuildConfigNode = {
 } & BuildConfigNodeBase;
 
 export type BuildConfigNodeStatic = BuildConfigNodeBase & {
+  /**
+   * @deprecated use type: "node" and docker: { type: "nginx" } instead
+   */
   type: "node-static";
   startCommand?: never;
   docker?: Omit<BuildConfigDockerBuiltInNgninx, "type"> | BuildConfigDocker;
@@ -271,6 +274,9 @@ export type BuildConfigRails = BuildConfigBase & {
 };
 
 export type BuildConfigStorybook = BuildConfigNodeBase & {
+  /**
+   * @deprecated use type: "node" and docker: { type: "nginx" } instead
+   */
   type: "storybook";
   startCommand?: never;
 };

package/src/pipeline/generatePipelineFiles.ts

@@ -4,48 +4,73 @@ 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,
+) {
+  const { jobs, image, stages, variables, workflow, ...pipelineRest } =
+    await createMainPipeline(pipelineType, 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 generatePipelineFiles<T extends PipelineType>(
   config: Config,
   pipelineType: T,
   mode: PipelineMode<T>,
 ) {
   if (mode === "childpipeline") {
-    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),
-      ]),
-    );
-    await writeYamlfile(`__pipeline.yml`, {
-      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,
-    });
-  } else {
-    const { jobs, image, stages, variables, workflow, ...pipelineRest } =
-      await createMainPipeline(pipelineType, config);
-    const jobsWithSortedProps = Object.fromEntries(
-      Object.entries(jobs).map(([jobName, job]) => [
-        jobName,
-        sortGitLabJobDefProps(job),
-      ]),
+    const pipelineContent = await generateChildPipelineContent(
+      config,
+      pipelineType,
     );
-    await writeYamlfile(`.gitlab-ci.yml`, {
-      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,
-    });
+    return writeYamlfile(`__pipeline.yml`, pipelineContent);
   }
+  const pipelineContent = await generateLocalPipelineContent(
+    config,
+    pipelineType,
+  );
+  return writeYamlfile(`.gitlab-ci.yml`, pipelineContent);
 }