feat(ng-dev): add support for verifying merge-mode reset before caretaker handoff

Author: josephperrott

ng-dev/caretaker/handoff/cli.ts

@@ -7,12 +7,10 @@
  */
 
 import {Argv, CommandModule} from 'yargs';
-
 import {addGithubTokenOption} from '../../utils/git/github-yargs.js';
-
 import {updateCaretakerTeamViaPrompt} from './update-github-team.js';
-
-export interface CaretakerHandoffOptions {}
+import {assertValidGithubConfig, getConfig} from '../../utils/config.js';
+import {verifyMergeMode} from './verify-merge-mode.js';
 
 /** Builds the command. */
 function builder(argv: Argv) {
@@ -21,11 +19,15 @@ function builder(argv: Argv) {
 
 /** Handles the command. */
 async function handler() {
+  const {mergeMode} = (await getConfig([assertValidGithubConfig])).github;
+  if (!(await verifyMergeMode(mergeMode))) {
+    return;
+  }
   await updateCaretakerTeamViaPrompt();
 }
 
 /** yargs command module for assisting in handing off caretaker.  */
-export const HandoffModule: CommandModule<{}, CaretakerHandoffOptions> = {
+export const HandoffModule: CommandModule<{}, {}> = {
   handler,
   builder,
   command: 'handoff',

ng-dev/caretaker/handoff/update-github-team.ts

@@ -22,6 +22,8 @@ export async function updateCaretakerTeamViaPrompt() {
   const config = await getConfig([assertValidCaretakerConfig, assertValidGithubConfig]);
   /** The github team name for the caretaker group. */
   const caretakerGroup = `${config.github.name}-caretaker`;
+  /** The github team name for the group containing the repository releaser. */
+  const releaserGroup = `${config.github.name}-releaser`;
   /** The github team name for the group containing all possible caretakers. */
   const caretakerGroupRoster = `${config.github.name}-caretaker-roster`;
   /** The github team name for the group containing all possible emea caretakers. */
@@ -74,7 +76,8 @@ export async function updateCaretakerTeamViaPrompt() {
   }
 
   try {
-    await setCaretakerGroup(caretakerGroup, Array.from(selected));
+    await setGithubTeam(caretakerGroup, Array.from(selected));
+    await setGithubTeam(releaserGroup, Array.from(selected));
   } catch {
     return Log.error('  ✘  Failed to update caretaker group.');
   }
@@ -98,7 +101,7 @@ async function getGroupMembers(group: string) {
   }
 }
 
-async function setCaretakerGroup(group: string, members: string[]) {
+async function setGithubTeam(group: string, members: string[]) {
   /** The authenticated GitClient instance. */
   const git = await AuthenticatedGitClient.get();
   /** The full name of the group <org>/<group name>. */
@@ -127,7 +130,7 @@ async function setCaretakerGroup(group: string, members: string[]) {
     });
   };
 
-  Log.debug(`Caretaker Group: ${fullSlug}`);
+  Log.debug(`Github Team: ${fullSlug}`);
   Log.debug(`Current Membership: ${current.join(', ')}`);
   Log.debug(`New Membership:     ${members.join(', ')}`);
   Log.debug(`Removed:            ${removed.join(', ')}`);

ng-dev/caretaker/handoff/verify-merge-mode.ts

@@ -0,0 +1,40 @@
+/**
+ * @license
+ * Copyright Google LLC
+ *
+ * Use of this source code is governed by an MIT-style license that can be
+ * found in the LICENSE file at https://angular.io/license
+ */
+
+import {RepositoryMergeModes} from '../../utils/config';
+import {bold, green, Log, red} from '../../utils/logging';
+import {Prompt} from '../../utils/prompt';
+import {getCurrentMergeMode, setRepoMergeMode} from '../../utils/git/repository-merge-mode';
+
+export async function verifyMergeMode(expectedMode: RepositoryMergeModes): Promise<boolean> {
+  const mode = await getCurrentMergeMode();
+  if (mode === expectedMode) {
+    return true;
+  }
+
+  Log.info(`The repository merge-mode is currently ${bold(mode)} and must be reset before handoff`);
+  if (
+    await Prompt.confirm({
+      message: `Would you like to reset this to ${expectedMode}`,
+      default: true,
+    })
+  ) {
+    try {
+      await setRepoMergeMode(expectedMode);
+      Log.info(`${green('✔')} Successfuly set merge-mode to ${expectedMode}`);
+      return true;
+    } catch (err) {
+      Log.info(`${red('✘')} Failed to update merge-mode`);
+      Log.info(err);
+      return false;
+    }
+  }
+  // User chose not to reset merge-mode
+  Log.info('Aborting...');
+  return false;
+}