feat(scripts): allow forcing releases (#3221)

Author: shortcuts

config/release.config.json

@@ -126,7 +126,7 @@
         "lts": "2024-01-01",
         "end": "2026-08-01"
       },
-      "3.0.0.beta.5": {
+      "3.0.0.beta.6": {
         "start": "2024-06-21",
         "end": "2026-06-21",
         "prerelease": true

scripts/cli/index.ts

@@ -1,4 +1,5 @@
 import { Argument, program } from 'commander';
+import semver from 'semver';
 
 import { buildClients } from '../buildClients.js';
 import { LANGUAGES, setVerbose } from '../common.js';
@@ -201,10 +202,20 @@ program
   .description('Releases the client')
   .addArgument(args.languages)
   .option(flags.verbose.flag, flags.verbose.description)
-  .option('-m, --major', 'triggers a major release for the given language list')
+  .option<semver.ReleaseType>(
+    '-rt --releaseType <type>',
+    'triggers a release for the given language list with the given releaseType',
+    (value, _previous) => {
+      if (semver.RELEASE_TYPES.includes(value as semver.ReleaseType)) {
+        return value as semver.ReleaseType;
+      }
+      return 'patch';
+    },
+    undefined,
+  )
   .option('-d, --dry-run', 'does not push anything to GitHub')
   .option('-gg, --generate-graph', 'only generates the graph')
-  .action(async (langArgs: LangArg[], { verbose, major, dryRun, generateGraph }) => {
+  .action(async (langArgs: LangArg[], { verbose, releaseType, dryRun, generateGraph }) => {
     setVerbose(Boolean(verbose));
 
     if (generateGraph) {
@@ -219,7 +230,7 @@ program
 
     await createReleasePR({
       languages: langArgs.includes(ALL) ? LANGUAGES : (langArgs as Language[]),
-      major,
+      releaseType,
       dryRun,
     });
   });

scripts/release/__tests__/createReleasePR.test.ts

@@ -3,6 +3,7 @@ import { afterAll, describe, expect, it, vi } from "vitest";
 import releaseConfig from '../../../config/release.config.json' assert { type: 'json' };
 import type { PassedCommit } from '../types.js';
 import { LANGUAGES } from "../../common.js";
+import { ReleaseType } from "semver";
 
 const gitAuthor = releaseConfig.gitAuthor;
 
@@ -458,7 +459,8 @@ describe('createReleasePR', () => {
       expect(versions.javascript.next).toEqual('1.0.0');
     });
 
-    it('allows forcing major releases', async () => {
+    for (const releaseType of ['major', 'minor', 'patch', 'prerelease']) {
+    it(`allows forcing ${releaseType} releases`, async () => {
       const versions = await decideReleaseStrategy({
         versions: {
           javascript: {
@@ -473,18 +475,14 @@ describe('createReleasePR', () => {
         },
         commits: [],
         languages: LANGUAGES,
-        major: true
+        releaseType: releaseType as ReleaseType,
       });
 
-      expect(versions.javascript.releaseType).toEqual('major');
-      expect(versions.javascript.next).toEqual('1.0.0');
-
-      expect(versions.php.releaseType).toEqual('major');
-      expect(versions.php.next).toEqual('1.0.0');
-
-      expect(versions.java.releaseType).toEqual('major');
-      expect(versions.java.next).toEqual('1.0.0');
+      expect(versions.javascript.releaseType).toEqual(releaseType);
+      expect(versions.php.releaseType).toEqual(releaseType);
+      expect(versions.java.releaseType).toEqual(releaseType);
     });
+    }
 
     it('allows releasing subset of clients', async () => {
       const versions = await decideReleaseStrategy({

scripts/release/createReleasePR.ts

@@ -213,13 +213,13 @@ export async function decideReleaseStrategy({
   versions,
   commits,
   languages,
-  major,
+  releaseType,
   dryRun,
 }: {
   versions: VersionsBeforeBump;
   commits: PassedCommit[];
   languages: Language[];
-  major?: boolean;
+  releaseType?: semver.ReleaseType;
   dryRun?: boolean;
 }): Promise<Versions> {
   const versionsToPublish: Versions = {};
@@ -253,11 +253,13 @@ export async function decideReleaseStrategy({
 
     console.log(`Deciding next version bump for ${lang}.`);
 
-    if (dryRun) {
+    // we force the release for this language in this case if there was no commits
+    if (dryRun || releaseType) {
       nbGitDiff = 1;
+      commitsPerLang.length = 1;
     }
 
-    if (!major && (nbGitDiff === 0 || commitsPerLang.length === 0)) {
+    if (nbGitDiff === 0 || commitsPerLang.length === 0) {
       versionsToPublish[lang] = {
         ...version,
         noCommit: true,
@@ -277,32 +279,36 @@ export async function decideReleaseStrategy({
       continue;
     }
 
-    let releaseType: semver.ReleaseType = 'patch';
+    let langReleaseType: semver.ReleaseType = 'patch';
     let skipRelease = false;
     const commitTypes = new Set(commitsPerLang.map(({ type }) => type));
 
     switch (true) {
-      case major || commitsPerLang.some((commit) => commit.message.includes('BREAKING CHANGE')):
-        releaseType = 'major';
+      case commitsPerLang.some((commit) => commit.message.includes('BREAKING CHANGE')):
+        langReleaseType = 'major';
         break;
       case semver.prerelease(currentVersion) && !currentVersion.endsWith('-SNAPSHOT'):
-        releaseType = 'prerelease';
+        langReleaseType = 'prerelease';
         break;
       case commitTypes.has('feat'):
-        releaseType = 'minor';
+        langReleaseType = 'minor';
         break;
       case !commitTypes.has('fix'):
         skipRelease = true;
         break;
       default:
-        releaseType = 'patch';
+        langReleaseType = 'patch';
+    }
+
+    if (releaseType) {
+      langReleaseType = releaseType;
     }
 
     versionsToPublish[lang] = {
       ...version,
-      releaseType,
+      releaseType: langReleaseType,
       skipRelease,
-      next: getNextVersion(currentVersion, releaseType),
+      next: getNextVersion(currentVersion, langReleaseType),
     };
   }
 
@@ -486,11 +492,11 @@ export async function updateSLA(versions: Versions, graphOnly?: boolean): Promis
 
 export async function createReleasePR({
   languages,
-  major,
+  releaseType,
   dryRun,
 }: {
   languages: Language[];
-  major?: boolean;
+  releaseType?: semver.ReleaseType;
   dryRun?: boolean;
 }): Promise<void> {
   if (!dryRun) {
@@ -504,7 +510,7 @@ export async function createReleasePR({
     versions: readVersions(),
     commits: validCommits,
     languages,
-    major,
+    releaseType,
   });
 
   await updateSLA(versions, false);

website/docs/contributing/CLI/release-commands.md

@@ -16,11 +16,12 @@ apic release <language... | all>
 
 ### Available options
 
-| Option         | Command               | Description                                                   |
-|----------------|:----------------------|:--------------------------------------------------------------|
-| verbose        | -v, --verbose         | Make the process verbose, display logs from third party tools |
-| dry run        | -d, --dry-run         | Locally generate a new release but do not push to GitHub      |
-| generate graph | -gg, --generate-graph | Generates the SLA graph for the given parameters              |
+| Option         | Command               | Description                                                                                      |
+|----------------|:----------------------|:------------------------------------------------------------------------------------------------ |
+| verbose        | -v, --verbose         | Make the process verbose, display logs from third party tools                                    |
+| dry run        | -d, --dry-run         | Locally generate a new release but do not push to GitHub                                         |
+| generate graph | -gg, --generate-graph | Generates the SLA graph for the given parameters                                                 |
+| releaseType    | -rt, --releaseType    | Forces the release script to create a release for the given client list of the given releaseType |
 
 ## Release