feat: add sdkver max major version configuration option

docs/configuration.md

@@ -34,6 +34,7 @@ initial-development: false  # OPTIONAL, defaults to `true`
 | `release-branches` | `/^release\/.*\d+\.\d+\.*$/` | A regex specifying from which branch(es) only `PATCH` version bump are allowed. |
 | `prereleases` | `undefined` | A string specifying the prereleases prefix. |
 | `sdkver-create-release-branches` | `false` | For SdkVer versioning scheme only: push a new branch if an RC or release build is performed on a non-release branch. If this config value is boolean `true`, the branch shall be of the form `release/N.N`. If this value is set to a string, it shall be used as the branch name prefix and appended with the major and minor release numbers, e.g. config value  `"rel/"` results in a branch named `rel/N.N`. |
+| `sdkver-max-major` | `0` | For SdkVer versioning scheme only: do not bump major version when breaking changes are found in case the maximum configured major version is already reached. |
 
 > :bulb: By default `commisery-action` will search for the file `.commisery.yml`. 
 You can specify a different file with the `config` input parameter.

src/bump.ts

@@ -753,7 +753,7 @@ export async function bumpSdkVer(
   createChangelog: boolean
 ): Promise<boolean> {
   const isReleaseBranch = branchName.match(config.releaseBranches) !== null;
-  const hasBreakingChange = bumpInfo.processedCommits.some(
+  let hasBreakingChange = bumpInfo.processedCommits.some(
     c => c.message?.breakingChange
   );
   if (!bumpInfo.foundVersion) return false; // should never happen
@@ -763,6 +763,16 @@ export async function bumpSdkVer(
 
   let cv = SemVer.copy(bumpInfo.foundVersion);
 
+  // Do not bump major version when breaking change is found in case
+  // the max configured major version is already reached
+  if (
+    config.sdkverMaxMajor !== undefined &&
+    config.sdkverMaxMajor > 0 &&
+    cv.major >= config.sdkverMaxMajor
+  ) {
+    hasBreakingChange = false;
+  }
+
   // Get the latest draft release matching our current version's prefix.
   // Don't look at the draft version on a release branch; the current version
   // should always reflect the version to be bumped (as no dev releases are

src/config.ts

@@ -74,6 +74,7 @@ const CONFIG_ITEMS = [
   "release-branches",
   "prereleases",
   "sdkver-create-release-branches",
+  "sdkver-max-major",
 ];
 
 const VERSION_SCHEMES = ["semver", "sdkver"];
@@ -107,6 +108,7 @@ export class Configuration {
   tags: IConfigurationRules = DEFAULT_ACCEPTED_TAGS;
   rules: Map<string, IRuleConfigItem> = new Map<string, IRuleConfigItem>();
   sdkverCreateReleaseBranches?: string = undefined;
+  sdkverMaxMajor = 0;
 
   set initialDevelopment(initialDevelopment: boolean) {
     this._initialDevelopment = initialDevelopment;
@@ -365,14 +367,30 @@ export class Configuration {
             );
           }
           break;
+
+        case "sdkver-max-major":
+          /* Example YAML:
+           *   sdkver-max-major: 1  # defaults to 0
+           */
+          if (typeof data[key] === "number") {
+            this.sdkverMaxMajor = data[key];
+          } else {
+            throw new Error(
+              `Incorrect type '${typeof data[
+                key
+              ]}' for '${key}', must be '${typeof this.sdkverMaxMajor}'!`
+            );
+          }
+          break;
       }
     }
     if (
-      this.sdkverCreateReleaseBranches !== undefined &&
+      (this.sdkverCreateReleaseBranches !== undefined ||
+        this.sdkverMaxMajor !== 0) &&
       this.versionScheme !== "sdkver"
     ) {
       core.warning(
-        "The configuration option `sdkver-create-release-branches` is only relevant " +
+        "The configuration options `sdkver-create-release-branches` and `sdkver-max-major` are only relevant " +
           'when the `version-scheme` is set to `"sdkver"`.'
       );
     }
@@ -411,6 +429,7 @@ export class Configuration {
     config.tags = JSON.parse(JSON.stringify(this.tags));
     config.rules = new Map(JSON.parse(JSON.stringify(Array.from(this.rules))));
     config.sdkverCreateReleaseBranches = this.sdkverCreateReleaseBranches;
+    config.sdkverMaxMajor = this.sdkverMaxMajor;
     return config;
   }
 }