ci(release): Improve handling release channel and enable providing it as an option

Author: minwork

tools/scripts/release/cli.ts

@@ -3,13 +3,17 @@ import { parseCSV } from 'nx/src/command-line/yargs-utils/shared-options';
 import chalk from 'chalk';
 import { printHeader } from '../utils/output';
 import { execaSync } from 'execa';
+import { ReleaseChannel, releaseChannelPreid } from './release.consts';
+import { ReleasePreidValue } from './release.types';
 
 export function parseReleaseCliOptions() {
   return yargs
     .version(false) // don't use the default meaning of version in yargs
-    .option('version', {
-      description: 'Explicit version specifier to use, if overriding conventional commits',
+    .option('channel', {
+      alias: 'c',
+      description: 'Explicit channel specifier to use when not deploying based on branch',
       type: 'string',
+      choices: Object.values(ReleaseChannel),
     })
     .option('dryRun', {
       alias: 'd',
@@ -40,18 +44,42 @@ export function parseReleaseCliOptions() {
     .parseAsync();
 }
 
-export function getOptionsBasedOnBranch(): { isPrerelease: boolean; preid?: string; tag: string } {
-  // Get current branch
-  const { stdout: branch } = execaSync('git', ['branch', '--show-current']);
+export function parseReleaseOptions({ channel }: { channel?: ReleaseChannel }): {
+  isPrerelease: boolean;
+  preid?: string;
+  tag: ReleaseChannel;
+} {
+  let isPrerelease: boolean;
+  let preid: ReleasePreidValue;
+  let tag: ReleaseChannel;
 
-  // Determine options based on branch
-  const isPrerelease = branch !== 'main';
-  const preid: string | undefined = isPrerelease ? 'preview' : undefined;
-  const tag: string = isPrerelease ? 'preview' : 'latest';
+  let selectedChannel: ReleaseChannel;
 
-  // Output which branch is used
-  console.log(printHeader('branch', 'blueBright'), `Detecting current git branch\n`);
-  console.log(`${chalk.blueBright(branch)} 🔀 Using "${chalk.yellow(preid ?? '[empty]')}" preid\n`);
+  console.log(printHeader('channel', 'blueBright'), `Detecting release channel...\n`);
+
+  if (!channel) {
+    // Auto determine based on branch
+    const { stdout: branch } = execaSync('git', ['branch', '--show-current']);
+    console.log(`🚫 No channel specified, using current git branch ${chalk.blueBright(branch)}`);
+    selectedChannel = branch === 'main' ? ReleaseChannel.Latest : ReleaseChannel.Preview;
+  } else {
+    selectedChannel = channel;
+  }
+
+  console.log(`🔀 ${chalk.yellow(selectedChannel)} channel selected for release\n`);
+
+  switch (selectedChannel) {
+    case ReleaseChannel.Latest:
+      isPrerelease = false;
+      break;
+    case ReleaseChannel.Preview:
+    default:
+      isPrerelease = true;
+      break;
+  }
+
+  preid = releaseChannelPreid[selectedChannel];
+  tag = selectedChannel;
 
   return {
     isPrerelease,

tools/scripts/release/release.consts.ts

@@ -0,0 +1,11 @@
+import { ReleasePreidValue } from './release.types';
+
+export enum ReleaseChannel {
+  Preview = 'preview',
+  Latest = 'latest',
+}
+
+export const releaseChannelPreid = {
+  [ReleaseChannel.Preview]: 'preview',
+  [ReleaseChannel.Latest]: undefined,
+} satisfies Record<ReleaseChannel, ReleasePreidValue>;

tools/scripts/release/release.ts

@@ -4,14 +4,14 @@ import chalk from 'chalk';
 import { createProjectGraphAsync } from 'nx/src/project-graph/project-graph';
 import { printHeader } from '../utils/output';
 import { syncPackageJson } from './publish';
-import { getOptionsBasedOnBranch, parseReleaseCliOptions } from './cli';
+import { parseReleaseOptions, parseReleaseCliOptions } from './cli';
 import { handlePrereleaseVersioning, handleRegularReleaseVersioning } from './version';
 import { handlePrereleaseChangelog, handleRegularReleaseChangelog } from './changelog';
 
 (async () => {
   const options = await parseReleaseCliOptions();
   const graph = await createProjectGraphAsync({ exitOnError: true });
-  const { tag, preid, isPrerelease } = getOptionsBasedOnBranch();
+  const { tag, preid, isPrerelease } = parseReleaseOptions(options);
 
   const releaseEnabled = process.env.RELEASE_ENABLED === '1' || process.env.RELEASE_ENABLED === 'true';
 

tools/scripts/release/release.types.ts

@@ -0,0 +1 @@
+export type ReleasePreidValue = string | undefined;