feat(release-cli): Support custom (classic) releases (elastic#8629)

Author: tkajtoch

packages/release-cli/src/cli.ts

@@ -39,6 +39,7 @@ export const cli = () => {
           })
           .option('allowCustom', {
             type: 'boolean',
+            description: '[UNSAFE!] Allow custom releases from unpushed changes. This should only be used with snapshot or custom releases',
             default: false,
           })
           .option('verbose', {
@@ -53,6 +54,11 @@ export const cli = () => {
               'Skip user prompts and proceed with recommended settings. Use in CI only!',
             default: false,
           })
+          .option('skipUpdateVersions', {
+            type: 'boolean',
+            description: '[UNSAFE!] Skip the update version step. This should only be used for special releases like backports. The --workspaces argument is required when this argument is set.',
+            default: false,
+          })
           .option('useAuthToken', {
             type: 'boolean',
             description:
@@ -68,6 +74,7 @@ export const cli = () => {
           allowCustom,
           verbose,
           skipPrompts,
+          skipUpdateVersions,
           useAuthToken,
         } = argv;
         const logger = new Logger(verbose);
@@ -79,6 +86,7 @@ export const cli = () => {
             workspaces,
             logger,
             skipPrompts,
+            skipUpdateVersions,
             useAuthToken,
             allowCustomReleases: allowCustom,
           });

packages/release-cli/src/release.ts

@@ -29,6 +29,7 @@ export interface ReleaseOptions {
   logger: Logger;
   allowCustomReleases: boolean;
   skipPrompts: boolean;
+  skipUpdateVersions: boolean;
   useAuthToken: boolean;
 }
 
@@ -45,8 +46,10 @@ export const release = async (options: ReleaseOptions) => {
     }
 
     if (options.tag !== 'latest') {
-      throw new ValidationError(
-        'Custom tags are not allowed for type `official`! Please use another type to perform custom releases'
+      logger.warning(
+        `A custom tag "${options.tag}" was provided for the official` +
+        ` release type. This should be used only for special releases like` +
+        ` backports. Stop here if you don't know what you're doing!`
       );
     }
   } else if (type === 'snapshot') {
@@ -68,6 +71,14 @@ export const release = async (options: ReleaseOptions) => {
     throw new ValidationError('Skipping prompts is not allowed when not using auth tokens');
   }
 
+  if (options.skipUpdateVersions) {
+    logger.warning('--skip-update-versions is set');
+
+    if (!options.workspaces?.length) {
+      throw new ValidationError('--workspaces must be set when --skip-update-version is used');
+    }
+  }
+
   const allWorkspaces = await getYarnWorkspaces();
   let currentWorkspaces: Array<YarnWorkspace> = [];
 

packages/release-cli/src/steps/init_checks.ts

@@ -31,17 +31,18 @@ export const stepInitChecks = async (options: ReleaseOptions) => {
 
   // Check if releasing from main branch
   const currentBranch = await getCurrentBranch();
-  if (currentBranch !== 'main' && type === 'official') {
+  if (currentBranch !== 'main' && type === 'official' && !allowCustomReleases) {
     throw new ValidationError(
       'Official releases are only allowed from the `main` branch!'
     );
   }
 
   if (!(await isWorkingTreeClean())) {
     throw new ValidationError(
-      'Git working tree is dirty. Please clean up your working tree from any uncommited changes and try again.',
-      `To clean local changes and restore the branch to remote state, please run:` +
-        `\n  ${chalk.yellowBright(
+      'Git working tree is dirty. Please clean up your working tree' +
+      ' from any uncommited changes and try again.',
+      `To clean local changes and restore the branch to remote state,` +
+        ` please run:\n  ${chalk.yellowBright(
           `git reset --hard upstream/${currentBranch}`
         )}\n` +
         `Please note that ${chalk.underline.bold(
@@ -56,16 +57,11 @@ export const stepInitChecks = async (options: ReleaseOptions) => {
   logger.debug(`Local HEAD = ${localHash}`);
 
   if (localHash !== remoteHash) {
-    if (type === 'official') {
-      throw new ValidationError(
-        'Local `main` branch is out of sync with the upstream branch. Please pull the latest changes and try again.'
-      );
-    }
-
     if (!allowCustomReleases) {
       throw new ValidationError(
-        'Local HEAD does not match the remote HEAD. Use --allow-custom to create a custom non-official release ' +
-          'if that really is what you were planning to do.'
+        'Local HEAD does not match the remote HEAD. Use --allow-custom to' +
+          ' create a custom non-official release if that really is what' +
+          'you were planning to do.'
       );
     } else {
       logger.warning('Local HEAD does not match the remote HEAD');
@@ -82,7 +78,8 @@ export const stepInitChecks = async (options: ReleaseOptions) => {
   const registryUser = await getAuthenticatedUser();
   if (!registryUser) {
     throw new ValidationError(
-      'Authentication to npmjs is required. Please log in before running this command again.',
+      'Authentication to npmjs is required. Please log in before running' +
+      ' this command again.',
       `To authenticate run the following command:\n` +
         `  ${chalk.yellowBright('yarn npm login')}`
     );

packages/release-cli/src/steps/update_versions.ts

@@ -35,7 +35,12 @@ export const stepUpdateVersions = async (
   options: ReleaseOptions,
   workspaces: Array<YarnWorkspace>
 ) => {
-  const { logger } = options;
+  const { logger, skipUpdateVersions } = options;
+
+  if (skipUpdateVersions) {
+    logger.warning('Skipping the update versions step');
+    return workspaces;
+  }
 
   logger.info('Updating package versions and changelogs');