@catladder/pipeline 3.13.0 → 3.14.0

package/examples/__snapshots__/workspace-api-www.test.ts.snap

@@ -28,6 +28,11 @@ stages:
   - verify review
   - verify stage
   - verify prod
+  - agents
+  - agents dev
+  - agents review
+  - agents stage
+  - agents prod
   - rollback
   - rollback dev
   - rollback review
@@ -48,6 +53,10 @@ variables:
 workflow:
   name: $PIPELINE_ICON $PIPELINE_NAME
   rules:
+    - if: $CI_PIPELINE_SOURCE  == "trigger"
+      variables:
+        PIPELINE_ICON: 🤖
+        PIPELINE_NAME: Thinking...
     - if: $CI_MERGE_REQUEST_ID
       variables:
         PIPELINE_ICON: 🐱🔨
@@ -59,7 +68,7 @@ workflow:
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
       variables:
         PIPELINE_ICON: 🐱🔨
-        PIPELINE_NAME: Main $CI_COMMIT_REF_NAME
+        PIPELINE_NAME: Main
     - when: always
       variables:
         PIPELINE_ICON: 🐱❓
@@ -108,7 +117,11 @@ before_script:
     - cd .
     - yarn npm audit --environment production
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_MERGE_REQUEST_ID
   needs: []
   retry: &a1
@@ -152,7 +165,11 @@ before_script:
       paths:
         - node_modules
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_MERGE_REQUEST_ID
   needs: []
   retry: *a1
@@ -191,7 +208,11 @@ before_script:
       paths:
         - node_modules
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_MERGE_REQUEST_ID
   needs: []
   retry: *a1
@@ -280,6 +301,8 @@ before_script:
     when: always
     reports: {}
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
   needs: []
   retry: *a1
@@ -368,6 +391,8 @@ before_script:
     when: always
     reports: {}
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_MERGE_REQUEST_ID
   needs: []
   retry: *a1
@@ -456,6 +481,8 @@ before_script:
     when: always
     reports: {}
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_TAG
   needs: []
   retry: *a1
@@ -544,6 +571,8 @@ before_script:
     when: always
     reports: {}
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_TAG
   needs: []
   retry: *a1
@@ -601,6 +630,8 @@ before_script:
       paths:
         - api/.yarn
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
   needs:
     - job: '🔸 myWorkspace 🔨 app | dev '
@@ -622,6 +653,8 @@ before_script:
     paths:
       - __sbom.json
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
   needs: []
   retry: *a1
@@ -718,6 +751,8 @@ before_script:
     reports:
       dotenv: gitlab_environment.env
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: on_success
       if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
   needs:
@@ -760,6 +795,8 @@ before_script:
   rules:
     - if: $CI_COMMIT_BRANCH =~ /^[0-9]+\\.([0-9]+|x)\\.x$/
       when: on_success
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: manual
       if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
   needs: []
@@ -819,6 +856,8 @@ before_script:
       paths:
         - api/.yarn
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_MERGE_REQUEST_ID
   needs:
     - job: '🔸 myWorkspace 🔨 app | review '
@@ -840,6 +879,8 @@ before_script:
     paths:
       - __sbom.json
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_MERGE_REQUEST_ID
   needs: []
   retry: *a1
@@ -939,6 +980,8 @@ before_script:
     reports:
       dotenv: gitlab_environment.env
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: on_success
       if: $CI_MERGE_REQUEST_ID
   needs:
@@ -984,6 +1027,8 @@ before_script:
   rules:
     - if: $CI_COMMIT_BRANCH =~ /^[0-9]+\\.([0-9]+|x)\\.x$/
       when: on_success
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: manual
       if: $CI_MERGE_REQUEST_ID
   needs: []
@@ -1043,6 +1088,8 @@ before_script:
       paths:
         - api/.yarn
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_TAG
   needs:
     - job: '🔸 myWorkspace 🔨 app | stage '
@@ -1064,6 +1111,8 @@ before_script:
     paths:
       - __sbom.json
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_TAG
   needs: []
   retry: *a1
@@ -1159,6 +1208,8 @@ before_script:
     reports:
       dotenv: gitlab_environment.env
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: on_success
       if: $CI_COMMIT_TAG
   needs:
@@ -1195,6 +1246,8 @@ before_script:
   rules:
     - if: $CI_COMMIT_BRANCH =~ /^[0-9]+\\.([0-9]+|x)\\.x$/
       when: on_success
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: manual
       if: $CI_COMMIT_TAG
   needs: []
@@ -1254,6 +1307,8 @@ before_script:
       paths:
         - api/.yarn
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_TAG
   needs:
     - job: '🔸 myWorkspace 🔨 app | prod '
@@ -1275,6 +1330,8 @@ before_script:
     paths:
       - __sbom.json
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_TAG
   needs: []
   retry: *a1
@@ -1370,6 +1427,8 @@ before_script:
     reports:
       dotenv: gitlab_environment.env
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: manual
       if: $CI_COMMIT_TAG
   needs:
@@ -1406,6 +1465,8 @@ before_script:
   rules:
     - if: $CI_COMMIT_BRANCH =~ /^[0-9]+\\.([0-9]+|x)\\.x$/
       when: on_success
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: manual
       if: $CI_COMMIT_TAG
   needs: []
@@ -1465,6 +1526,8 @@ before_script:
       paths:
         - www/.yarn
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
   needs:
     - job: '🔸 myWorkspace 🔨 app | dev '
@@ -1486,6 +1549,8 @@ before_script:
     paths:
       - __sbom.json
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
   needs: []
   retry: *a1
@@ -1585,6 +1650,8 @@ before_script:
     reports:
       dotenv: gitlab_environment.env
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: on_success
       if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
   needs:
@@ -1627,6 +1694,8 @@ before_script:
   rules:
     - if: $CI_COMMIT_BRANCH =~ /^[0-9]+\\.([0-9]+|x)\\.x$/
       when: on_success
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: manual
       if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_COMMIT_MESSAGE !~ /^chore\\(release\\).*/
   needs: []
@@ -1686,6 +1755,8 @@ before_script:
       paths:
         - www/.yarn
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_MERGE_REQUEST_ID
   needs:
     - job: '🔸 myWorkspace 🔨 app | review '
@@ -1707,6 +1778,8 @@ before_script:
     paths:
       - __sbom.json
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_MERGE_REQUEST_ID
   needs: []
   retry: *a1
@@ -1809,6 +1882,8 @@ before_script:
     reports:
       dotenv: gitlab_environment.env
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: on_success
       if: $CI_MERGE_REQUEST_ID
   needs:
@@ -1854,6 +1929,8 @@ before_script:
   rules:
     - if: $CI_COMMIT_BRANCH =~ /^[0-9]+\\.([0-9]+|x)\\.x$/
       when: on_success
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: manual
       if: $CI_MERGE_REQUEST_ID
   needs: []
@@ -1913,6 +1990,8 @@ before_script:
       paths:
         - www/.yarn
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_TAG
   needs:
     - job: '🔸 myWorkspace 🔨 app | stage '
@@ -1934,6 +2013,8 @@ before_script:
     paths:
       - __sbom.json
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_TAG
   needs: []
   retry: *a1
@@ -2032,6 +2113,8 @@ before_script:
     reports:
       dotenv: gitlab_environment.env
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: on_success
       if: $CI_COMMIT_TAG
   needs:
@@ -2068,6 +2151,8 @@ before_script:
   rules:
     - if: $CI_COMMIT_BRANCH =~ /^[0-9]+\\.([0-9]+|x)\\.x$/
       when: on_success
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: manual
       if: $CI_COMMIT_TAG
   needs: []
@@ -2127,6 +2212,8 @@ before_script:
       paths:
         - www/.yarn
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_TAG
   needs:
     - job: '🔸 myWorkspace 🔨 app | prod '
@@ -2148,6 +2235,8 @@ before_script:
     paths:
       - __sbom.json
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - if: $CI_COMMIT_TAG
   needs: []
   retry: *a1
@@ -2246,6 +2335,8 @@ before_script:
     reports:
       dotenv: gitlab_environment.env
   rules:
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: manual
       if: $CI_COMMIT_TAG
   needs:
@@ -2282,6 +2373,8 @@ before_script:
   rules:
     - if: $CI_COMMIT_BRANCH =~ /^[0-9]+\\.([0-9]+|x)\\.x$/
       when: on_success
+    - when: never
+      if: $CI_PIPELINE_SOURCE  == "trigger"
     - when: manual
       if: $CI_COMMIT_TAG
   needs: []
@@ -2299,6 +2392,9 @@ create release:
       if: $CI_COMMIT_MESSAGE =~ /^chore\\(release\\).*/
       when: never
     - &a3
+      if: $CI_PIPELINE_SOURCE  == "trigger"
+      when: never
+    - &a4
       if: $CI_PIPELINE_SOURCE  == "schedule"
       when: never
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $AUTO_RELEASE == "true"
@@ -2316,6 +2412,7 @@ create release:
   rules:
     - *a2
     - *a3
+    - *a4
     - if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
       when: manual
     - if: $CI_COMMIT_BRANCH =~ /^[0-9]+.([0-9]+|x).x$/

package/examples/cloud-run-with-agents.test.ts

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

package/examples/cloud-run-with-agents.ts

@@ -0,0 +1,36 @@
+import type { Config } from "../src";
+
+const config = {
+  appName: "agent-example-app",
+  customerName: "pan",
+  // Note: AI agents are experimental
+  agents: {
+    claude: {
+      type: "claude",
+    },
+  },
+  components: {
+    www: {
+      dir: "www",
+      build: {
+        type: "node",
+        cache: {
+          paths: [".next/cache"],
+        },
+      },
+      deploy: {
+        type: "google-cloudrun",
+        projectId: "google-project-id",
+        region: "europe-west6",
+      },
+    },
+  },
+} satisfies Config;
+
+export default config;
+
+export const information = {
+  title: "Cloud Run: With AI Agents",
+  description:
+    "Example showing how to configure AI agents for automated code review and issue analysis",
+};

package/package.json

@@ -53,7 +53,7 @@
     }
   ],
   "license": "MIT",
-  "version": "3.13.0",
+  "version": "3.14.0",
   "scripts": {
     "build:tsc": "yarn tsc",
     "build": "yarn build:compile && yarn build:inline-variables",

package/src/bash/bashEscape.ts

@@ -57,6 +57,12 @@ export const escapeDoubleQuotes = (value: string | null | undefined) =>
 export const escapeSingleQuotes = (value: string | null | undefined) =>
   value?.toString().replace(/'/g, "\\'");
 
+export const escapeBackTicks = (value: string | null | undefined) =>
+  value?.toString().replace(/`/g, "\\`");
+
+export const escapeNewlines = (value: string | null | undefined) =>
+  value?.toString().replace(/\n/g, "\\n");
+
 export type EscapeForDotEnvOptions = {
   quoteMode: "auto" | "always";
 };

package/src/pipeline/__tests__/__snapshots__/getPipelineStages.test.ts.snap

@@ -47,6 +47,15 @@ exports[`getPipelineStages() should return all envs for SIMPLE_CONFIG1 1`] = `
   "verify review2",
   "verify stage2",
   "verify prod2",
+  "agents",
+  "agents dev",
+  "agents review",
+  "agents stage",
+  "agents prod",
+  "agents dev2",
+  "agents review2",
+  "agents stage2",
+  "agents prod2",
   "rollback",
   "rollback dev",
   "rollback review",

package/src/pipeline/agent/createAgentContext.ts

@@ -0,0 +1,19 @@
+import type { Config } from "../../types";
+import type { AgentContext } from "../../types/context";
+
+export const createAgentContext = async (ctx: {
+  agentName: string;
+  config: Config;
+}): Promise<AgentContext> => {
+  const agentConfig = ctx.config.agents?.[ctx.agentName];
+  if (!agentConfig) {
+    throw new Error(`Agent ${ctx.agentName} not found in config`);
+  }
+  return {
+    type: "agent",
+    name: ctx.agentName,
+    //env: ctx.env,
+    fullConfig: ctx.config,
+    agentConfig: agentConfig,
+  };
+};

package/src/pipeline/agent/createAgentEventJob.ts

@@ -0,0 +1,35 @@
+import type { AgentContext, CatladderJob } from "../../types";
+import { getEventPrompt } from "./prompts";
+import { baseSetupScript, callClaude, createBaseAgentJob } from "./shared";
+import { getAgentUserId, getAgentUserName } from "./utils";
+
+export const createAgentEventJob = (context: AgentContext): CatladderJob => {
+  const baseJob = createBaseAgentJob(context);
+  // unfortunatly, we need to manage both, because the "@mention"-feature only works with the username
+  const agentUserId = getAgentUserId(context);
+  const agentUserName = getAgentUserName(context);
+  return {
+    interruptible: false, // do not cancel this job if it is running. Otherwise a commit to main will cancel it
+    ...baseJob,
+    variables: {
+      ...baseJob.variables,
+    },
+    name: context.name + "-agent-event",
+    rules: [
+      {
+        if: `$CI_PIPELINE_SOURCE  == "trigger" && ($ASSIGNEE_USER_ID == ${agentUserId} || $OBJECT_DESCRIPTION =~ /@${agentUserName}/)`,
+        when: "always",
+      },
+
+      {
+        when: "never",
+      },
+    ],
+    script: [
+      ...baseSetupScript,
+      ...callClaude({
+        prompt: getEventPrompt({ agentUserName: agentUserName }),
+      }),
+    ],
+  };
+};

package/src/pipeline/agent/createAgentReviewJob.ts

@@ -0,0 +1,33 @@
+import { RULE_IS_MERGE_REQUEST } from "../../rules";
+import type { AgentContext, CatladderJob } from "../../types";
+import { getMergeRequestPrompt } from "./prompts";
+import { baseSetupScript, callClaude, createBaseAgentJob } from "./shared";
+import { getAgentUserName } from "./utils";
+
+export const createAgentReviewJob = (context: AgentContext): CatladderJob => {
+  const baseJob = createBaseAgentJob(context);
+
+  const agentUserName = getAgentUserName(context);
+  return {
+    ...baseJob,
+    name: context.name + "-agent-review",
+
+    rules: [
+      {
+        ...RULE_IS_MERGE_REQUEST,
+        when: "always",
+      },
+      {
+        when: "never",
+      },
+    ],
+    script: [
+      ...baseSetupScript,
+      ...callClaude({
+        prompt: getMergeRequestPrompt({
+          agentUserName: agentUserName,
+        }),
+      }),
+    ],
+  };
+};

package/src/pipeline/agent/createJobsForAgentContext.ts

@@ -0,0 +1,7 @@
+import type { AgentContext } from "../../types";
+import { createAgentEventJob } from "./createAgentEventJob";
+import { createAgentReviewJob } from "./createAgentReviewJob";
+
+export const createJobsForAgentContext = (context: AgentContext) => {
+  return [createAgentEventJob(context), createAgentReviewJob(context)];
+};