make --dryRun more useful

Author: aduh95

components/git/release.js

@@ -15,7 +15,8 @@ const RELEASERS = 'releasers';
 
 const releaseOptions = {
   dryRun: {
-    describe: 'Skip all the steps that involve touching more than the local clone',
+    describe: 'Do not run steps that involve touching more than the local clone, ' +
+           'instead print the commands so the user can choose to run them manually',
     type: 'boolean'
   },
   prepare: {

lib/promote_release.js

@@ -118,17 +118,8 @@ export default class ReleasePromotion extends Session {
     await this.setupForNextRelease();
     cli.stopSpinner('Successfully set up for next release');
 
-    const shouldMergeProposalBranch = await cli.prompt(
-      'Merge proposal branch into staging branch?');
-    if (!shouldMergeProposalBranch) {
-      cli.warn(`Aborting release promotion for version ${version}`);
-      throw new Error('Aborted');
-    }
-
     // Merge vX.Y.Z-proposal into vX.x.
-    cli.startSpinner('Merging proposal branch');
     await this.mergeProposalBranch();
-    cli.stopSpinner('Merged proposal branch');
 
     // Cherry pick release commit to master.
     const shouldCherryPick = await cli.prompt(
@@ -147,7 +138,7 @@ export default class ReleasePromotion extends Session {
     // need to resolve, so confirm they've been resolved before
     // proceeding with next steps.
     cli.separator();
-    cli.info('Resovle the conflicts and commit the result');
+    cli.info('Resolve the conflicts and commit the result');
     cli.separator();
     const didResolveConflicts = await cli.prompt(
       'Finished resolving cherry-pick conflicts?', { defaultAnswer: true });
@@ -170,42 +161,11 @@ export default class ReleasePromotion extends Session {
       }
     }
 
-    // Push to the remote default branch
-    const shouldPushDefaultBranch = await cli.prompt(`Push to ${this.branch}?`,
-      { defaultAnswer: true });
-    if (!shouldPushDefaultBranch) {
-      cli.warn(`Aborting release promotion for version ${version}`);
-      throw new Error('Aborted');
-    }
-    if (this.dryRun) {
-      cli.info(`Skipping pushing to ${this.branch} in dry-run mode`);
-    } else {
-      await forceRunAsync('git', ['push', this.upstream, this.branch], { ignoreFailure: false });
-    }
-
-    // Push release tag.
-    const shouldPushTag = await cli.prompt('Push release tag?',
-      { defaultAnswer: true });
-    if (!shouldPushTag) {
-      cli.warn(`Aborting release promotion for version ${version}`);
-      throw new Error('Aborted');
-    }
-    await this.pushReleaseTag();
+    // Push to the remote default branch and release tag.
+    await this.pushTagAndDefaultBranchToRemote();
 
     // Promote and sign the release builds.
-    const shouldPromote = await cli.prompt('Promote and sign release builds?',
-      { defaultAnswer: true });
-    if (!shouldPromote) {
-      cli.warn(`Aborting release promotion for version ${version}`);
-      throw new Error('Aborted');
-    }
-
-    // TODO: move this to .ncurc
-    const defaultKeyPath = '~/.ssh/node_id_rsa';
-    const keyPath = await cli.prompt(
-      `Please enter the path to your ssh key (Default ${defaultKeyPath}): `,
-      { questionType: 'input', defaultAnswer: defaultKeyPath });
-    await this.promoteAndSignRelease(keyPath);
+    await this.promoteAndSignRelease();
 
     cli.separator();
     cli.ok(`Release promotion for ${version} complete.\n`);
@@ -218,16 +178,16 @@ export default class ReleasePromotion extends Session {
       ' 5. Tag @nodejs-social-team on #nodejs-release Slack channel.\n');
 
     cli.separator();
-    cli.info('Use the following command to create the release:');
+    cli.info('Use the following command to create the GitHub release:');
     cli.separator();
     cli.info(
       'awk \'' +
       `/^## ${this.date}, Version ${this.version.replaceAll('.', '\\.')} /,` +
       '/^<a id="[0-9]+\\.[0-9]+\\.[0-9]+"><\\x2fa>$/{' +
       'print buf; if(firstLine == "") firstLine = $0; else buf = $0' +
     `}' doc/changelogs/CHANGELOG_V${
-      this.versionComponents.major}.md | gh release create ${this.version} --verify-tag --latest=${
-        !this.isLTS} --title=${JSON.stringify(this.releaseTitle)} --notes-file -`);
+      this.versionComponents.major}.md | gh release create ${this.version} --verify-tag --latest${
+        this.isLTS ? '=false' : ''} --title=${JSON.stringify(this.releaseTitle)} --notes-file -`);
   }
 
   async verifyPRAttributes() {
@@ -399,42 +359,91 @@ export default class ReleasePromotion extends Session {
     ], { ignoreFailure: false });
   }
 
-  mergeProposalBranch() {
+  async mergeProposalBranch() {
     const { cli, dryRun, stagingBranch, versionComponents } = this;
+    const releaseBranch = `v${versionComponents.major}.x`;
+
+    let prompt = 'Merge proposal branch into staging branch?';
     if (dryRun) {
-      cli.info('Skipping merging the proposal branch in dry-run mode');
-      return;
+      cli.info('Run the following commands to merge the staging branch:');
+      cli.info(`git push ${this.upstream} HEAD:refs/heads/${releaseBranch}`);
+      cli.info(`git push ${this.upstream} HEAD:refs/heads/${stagingBranch}`);
+      prompt = 'Ready to continue?';
     }
 
-    const releaseBranch = `v${versionComponents.major}.x`;
+    const shouldMergeProposalBranch = await cli.prompt(prompt, { defaultAnswer: true });
+    if (!shouldMergeProposalBranch) {
+      cli.warn('Aborting release promotion');
+      throw new Error('Aborted');
+    } else if (dryRun) {
+      return;
+    }
 
     // TODO: find a solution for key passphrase from the terminal
-    return Promise.all([
+    cli.startSpinner('Merging proposal branch');
+    await Promise.all([
       forceRunAsync('git', ['push', this.upstream, `HEAD:refs/heads/${releaseBranch}`],
         { ignoreFailure: false }),
       forceRunAsync('git', ['push', this.upstream, `HEAD:refs/heads/${stagingBranch}`],
         { ignoreFailure: false })
     ]);
+    cli.stopSpinner('Merged proposal branch');
   }
 
-  pushReleaseTag() {
+  async pushTagAndDefaultBranchToRemote() {
     const { cli, dryRun, version } = this;
+    const tagVersion = `v${version}`;
+
+    let prompt = `Push release tag and ${this.branch} to ${this.upstream}?`;
     if (dryRun) {
-      cli.info('Skipping pushing the tag in dry-run mode');
+      cli.info('Run the following commands to push to remote:');
+      cli.info(`git push ${this.upstream} ${this.branch}`);
+      cli.info(`git push ${this.upstream} ${tagVersion}`);
+      prompt = 'Ready to continue?';
+    }
+
+    const shouldPushTag = await cli.prompt(prompt, { defaultAnswer: true });
+    if (!shouldPushTag) {
+      cli.warn('Aborting release promotion');
+      throw new Error('Aborted');
+    } else if (dryRun) {
       return;
     }
 
-    const tagVersion = `v${version}`;
-    return forceRunAsync('git', ['push', this.upstream, tagVersion], { ignoreFailure: false });
+    cli.startSpinner('Pushing to remote');
+    await Promise.all([
+      forceRunAsync('git', ['push', this.upstream, this.branch], { ignoreFailure: false }),
+      forceRunAsync('git', ['push', this.upstream, tagVersion], { ignoreFailure: false })
+    ]);
+    cli.stopSpinner(`Pushed ${tagVersion} and ${this.branch} to remote`);
   }
 
-  async promoteAndSignRelease(keyPath) {
+  async promoteAndSignRelease() {
     const { cli, dryRun } = this;
+    let prompt = 'Promote and sign release builds?';
+
     if (dryRun) {
-      cli.info('Skipping promoting the release in dry-run mode');
+      cli.info('Run the following command to sign and promote the release:');
+      cli.info('./tools/release.sh -i <keyPath>');
+      prompt = 'Ready to continue?';
+    }
+    const shouldPromote = await cli.prompt(prompt, { defaultAnswer: true });
+    if (!shouldPromote) {
+      cli.warn('Aborting release promotion');
+      throw new Error('Aborted');
+    } else if (dryRun) {
       return;
     }
+
+    // TODO: move this to .ncurc
+    const defaultKeyPath = '~/.ssh/node_id_rsa';
+    const keyPath = await cli.prompt(
+      `Please enter the path to your ssh key (Default ${defaultKeyPath}): `,
+      { questionType: 'input', defaultAnswer: defaultKeyPath });
+
+    cli.startSpinner('Signing and promoting the release');
     await forceRunAsync('./tools/release.sh', ['-i', keyPath], { ignoreFailure: false });
+    cli.stopSpinner('Release has been signed and promoted');
   }
 
   async cherryPickToDefaultBranch() {