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

Author: josephperrott

.github/local-actions/branch-manager/main.js

@@ -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,17 @@ function builder(argv: Argv) {
 
 /** Handles the command. */
 async function handler() {
+  const {
+    github: {mergeMode},
+  } = await getConfig([assertValidGithubConfig]);
+  if (mergeMode && !(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/cli.ts

@@ -0,0 +1,42 @@
+/**
+ * @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 currentMergeMode = await getCurrentMergeMode();
+  if (currentMergeMode === expectedMode) {
+    return true;
+  }
+
+  Log.info(
+    `The repository is currently set to ${bold(currentMergeMode)} and needs to 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;
+}

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

@@ -23,6 +23,9 @@ export type NgDevConfig<T = {}> = T & {
   __isNgDevConfigObject: boolean;
 };
 
+/** The available merge modes for repositories to utilize for normal usage. */
+export type RepositoryMergeModes = 'team-only' | 'caretaker-only';
+
 /**
  * Describes the Github configuration for dev-infra. This configuration is
  * used for API requests, determining the upstream remote, etc.
@@ -40,6 +43,11 @@ export interface GithubConfig {
   private?: boolean;
   /** Whether to default to use NgDevService for authentication. */
   useNgDevAuthService?: boolean;
+  /**
+   * The merge mode to use for the repository, either allowing only the caretaker to perform
+   * merges, or allowing all team members to do so.
+   */
+  mergeMode: RepositoryMergeModes;
 }
 
 /** Configuration describing how files are synced into Google. */
@@ -180,6 +188,9 @@ export function assertValidGithubConfig<T extends NgDevConfig>(
     if (config.github.owner === undefined) {
       errors.push(`"github.owner" is not defined`);
     }
+    if (config.github.mergeMode === undefined) {
+      errors.push(`"github.mergeMode" is not defined`);
+    }
   }
   if (errors.length) {
     throw new ConfigValidationError('Invalid `github` configuration', errors);