@catladder/pipeline 3.19.0 → 3.20.0

package/src/pipeline/gitlab/gitlabReleaseJobs.ts

@@ -1,23 +1,56 @@
-import { RULES_MANUAL_RELEASE, RULES_RELEASE } from "../../rules";
+import {
+  RULE_CONDITION_HOTFIX_BRANCH,
+  RULE_CONDITION_MAIN_BRANCH,
+  RULE_NEVER_ON_AGENT_TRIGGER,
+  RULE_NEVER_ON_RELEASE_COMMIT,
+  RULE_NEVER_ON_SCHEDULE,
+} from "../../rules";
 import { getRunnerImage } from "../../runner";
+import type { Config } from "../../types/config";
+import type { GitlabRule } from "../../types";
 
 const EXPIRED_TOKEN_HELP =
   "echo '👉 The project access token might be invald - run `project-renew-token` in catladder CLI to fix.'";
 
-export const getGitlabReleaseJobs = () => {
+const baseReleaseRules = [
+  RULE_NEVER_ON_RELEASE_COMMIT,
+  RULE_NEVER_ON_AGENT_TRIGGER,
+  RULE_NEVER_ON_SCHEDULE,
+];
+export const getGitlabReleaseJobs = (config: Config) => {
   return {
     ["create release"]: {
       stage: "release",
       image: getRunnerImage("semantic-release"),
       script: ["semanticRelease", EXPIRED_TOKEN_HELP],
-      rules: RULES_RELEASE,
+      rules: [
+        ...baseReleaseRules,
+        {
+          if: RULE_CONDITION_MAIN_BRANCH,
+          when: config.releases?.when === "auto" ? "on_success" : "manual",
+        },
+        {
+          if: RULE_CONDITION_HOTFIX_BRANCH,
+          when: "manual",
+        },
+      ] satisfies GitlabRule[],
     },
     ["⚠️ force create release"]: {
       stage: "release",
       image: getRunnerImage("semantic-release"),
       script: ["semanticRelease", EXPIRED_TOKEN_HELP],
       needs: [],
-      rules: RULES_MANUAL_RELEASE,
+      rules: [
+        ...baseReleaseRules,
+        {
+          if: RULE_CONDITION_MAIN_BRANCH,
+          when: "manual",
+        },
+        {
+          if: RULE_CONDITION_HOTFIX_BRANCH,
+          when: "manual",
+        },
+      ] satisfies GitlabRule[],
     },
   };
 };

package/src/rules/index.ts

@@ -39,35 +39,3 @@ export const RULE_IS_TAGGED_RELEASE: GitlabRule = {
 
 export const RULE_CONDITION_HOTFIX_BRANCH =
   "$CI_COMMIT_BRANCH =~ /^[0-9]+.([0-9]+|x).x$/";
-
-export const RULES_RELEASE: GitlabRule[] = [
-  RULE_NEVER_ON_RELEASE_COMMIT,
-  RULE_NEVER_ON_AGENT_TRIGGER,
-  RULE_NEVER_ON_SCHEDULE,
-  {
-    if: RULE_CONDITION_MAIN_BRANCH + ' && $AUTO_RELEASE == "true"',
-    when: "on_success",
-  },
-  {
-    if: RULE_CONDITION_MAIN_BRANCH,
-    when: "manual",
-  },
-  {
-    if: RULE_CONDITION_HOTFIX_BRANCH,
-    when: "manual",
-  },
-];
-
-export const RULES_MANUAL_RELEASE: GitlabRule[] = [
-  RULE_NEVER_ON_RELEASE_COMMIT,
-  RULE_NEVER_ON_AGENT_TRIGGER,
-  RULE_NEVER_ON_SCHEDULE,
-  {
-    if: RULE_CONDITION_MAIN_BRANCH,
-    when: "manual",
-  },
-  {
-    if: RULE_CONDITION_HOTFIX_BRANCH,
-    when: "manual",
-  },
-];

package/src/types/config.ts

@@ -7,6 +7,7 @@ import type { PartialDeep } from "./utils";
 import type { PipelineType, WorkspaceBuildConfig } from "..";
 import type { AgentConfig } from "./agent";
 import type { Hooks } from "./hooks";
+import type { ReleaseConfig } from "./release";
 
 export const ALL_PIPELINE_TRIGGERS = [
   "mainBranch",
@@ -237,4 +238,9 @@ export type Config<C extends ConfigProps = never> = {
    * hook into catladder generation
    */
   hooks?: Hooks;
+
+  /**
+   * configure tagged releases
+   */
+  releases?: ReleaseConfig;
 };

package/src/types/release.ts

@@ -0,0 +1,7 @@
+export type ReleaseConfig = {
+  /**
+   * Whether to release automatically or manually on main branch.
+   * Defaults to "manuel"
+   */
+  when?: "manual" | "auto";
+};