feat(ng-dev): create a caretaker config subcommand for updated repo properties

Create a config subcommand to allow for `get` and `set` actions against a defined list of custom properties on angular repositories. These will be used to set the merge mode of the repository being configured.

Author: josephperrott

ng-dev/caretaker/cli.ts

@@ -11,15 +11,20 @@ import {Argv} from 'yargs';
 import {assertValidCaretakerConfig, assertValidGithubConfig, getConfig} from '../utils/config.js';
 import {CheckModule} from './check/cli.js';
 import {HandoffModule} from './handoff/cli.js';
+import {MergeModeModule} from './merge-mode/cli.js';
 
 /** Build the parser for the caretaker commands. */
 export function buildCaretakerParser(argv: Argv) {
-  return argv.middleware(caretakerCommandCanRun, false).command(CheckModule).command(HandoffModule);
+  return argv
+    .middleware(caretakerCommandCanRun, false)
+    .command(MergeModeModule)
+    .command(CheckModule)
+    .command(HandoffModule);
 }
 
 function caretakerCommandCanRun() {
   try {
-    getConfig([assertValidCaretakerConfig, assertValidGithubConfig]);
+    getConfig([assertValidGithubConfig, assertValidCaretakerConfig]);
   } catch {
     info('The `caretaker` command is not enabled in this repository.');
     info(`   To enable it, provide a caretaker config in the repository's .ng-dev/ directory`);

ng-dev/caretaker/merge-mode/cli.ts

@@ -0,0 +1,47 @@
+/**
+ * @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 {Argv, Arguments, CommandModule} from 'yargs';
+import {Log} from '../../utils/logging';
+import {addGithubTokenOption} from '../../utils/git/github-yargs';
+import {setMergeModeRelease} from './release';
+import {resetMergeMode} from './reset';
+import {getCurrentMergeMode} from '../../utils/git/repository-merge-mode';
+
+interface Options {
+  mode?: string;
+}
+
+async function setMergeModeBuilder(argv: Argv): Promise<Argv<Options>> {
+  return addGithubTokenOption(argv).positional('mode', {
+    type: 'string',
+    choices: ['release', 'reset'],
+  });
+}
+
+async function setMergeModeHandler({mode}: Arguments<Options>) {
+  if (mode === undefined) {
+    const currentMode = await getCurrentMergeMode();
+    Log.info(`Repository merge-mode is currently set to: ${currentMode}`);
+    return;
+  }
+  if (mode === 'reset') {
+    return await resetMergeMode();
+  }
+  if (mode === 'release') {
+    return await setMergeModeRelease();
+  }
+  Log.error(`Unable to set the merge mode to the provided mode: ${mode}`);
+}
+
+export const MergeModeModule: CommandModule<{}, {}> = {
+  builder: setMergeModeBuilder,
+  handler: setMergeModeHandler,
+  command: ['merge-mode [mode]'],
+  describe: 'Set the repository merge mode',
+};

ng-dev/caretaker/merge-mode/release.ts

@@ -0,0 +1,17 @@
+import {setRepoMergeMode} from '../../utils/git/repository-merge-mode';
+import {green, Log, red} from '../../utils/logging';
+
+export async function setMergeModeRelease() {
+  try {
+    await setRepoMergeMode('release');
+    Log.info(`${green('✔')} Repository is set for release`);
+  } catch (err) {
+    Log.info(`${red('✘')} Failed to setup of repository for release`);
+    if (err instanceof Error) {
+      Log.info(err.message);
+      Log.debug(err.stack);
+      return;
+    }
+    Log.info(err);
+  }
+}

ng-dev/caretaker/merge-mode/reset.ts

@@ -0,0 +1,21 @@
+import {assertValidGithubConfig, getConfig} from '../../utils/config';
+import {setRepoMergeMode} from '../../utils/git/repository-merge-mode';
+import {green, Log, red} from '../../utils/logging';
+
+export async function resetMergeMode() {
+  try {
+    const {
+      github: {mergeMode},
+    } = await getConfig([assertValidGithubConfig]);
+    await setRepoMergeMode(mergeMode);
+    Log.info(`${green('✔')} Repository has been reset to the normal mode: ${mergeMode}`);
+  } catch (err) {
+    Log.info(`${red('✘')} Failed to reset the merge mode of the repository`);
+    if (err instanceof Error) {
+      Log.info(err.message);
+      Log.debug(err.stack);
+      return;
+    }
+    Log.info(err);
+  }
+}

ng-dev/utils/git/repository-merge-mode.ts

@@ -0,0 +1,81 @@
+/**
+ * @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 {Log} from '../logging';
+import {AuthenticatedGitClient} from './authenticated-git-client';
+
+const mergeModePropertyName = 'merge-mode';
+
+export async function getCurrentMergeMode() {
+  const git = await AuthenticatedGitClient.get();
+
+  const {data: properties} = await git.github.repos.customPropertiesForReposGetRepositoryValues({
+    owner: git.remoteConfig.owner,
+    repo: git.remoteConfig.name,
+  });
+
+  const property = properties.find(({property_name}) => property_name === mergeModePropertyName);
+  if (property === undefined) {
+    throw Error(`No repository configuration value with the key: ${mergeModePropertyName}`);
+  }
+
+  return property.value;
+}
+
+export async function setRepoMergeMode(value: string) {
+  const currentValue = await getCurrentMergeMode();
+  if (currentValue === value) {
+    Log.debug(
+      'Skipping update of repository configuration value as it is already set to the provided value',
+    );
+    return false;
+  }
+  const git = await AuthenticatedGitClient.get();
+  const {value_type, allowed_values} = await getRepoConfigValueDefinition(
+    mergeModePropertyName,
+    git,
+  );
+
+  if (value_type !== 'single_select') {
+    throw Error(
+      `Unable to update ${mergeModePropertyName} as its type is ${value_type}, currently the ` +
+        `only supported configuration type is single_select`,
+    );
+  }
+
+  if (!allowed_values!.includes(value)) {
+    throw Error(
+      `Unable to update ${mergeModePropertyName}. The value provided must use one of: ` +
+        `${allowed_values!.join(', ')}\nBut "${value}" was provided as the value`,
+    );
+  }
+
+  // All members of the github team, `team` have been assigned the custom role `Custom Property
+  // Editor` allowing their accounts to update the values the custom properties in Angular repos.
+  await git.github.repos.customPropertiesForReposCreateOrUpdateRepositoryValues({
+    owner: git.remoteConfig.owner,
+    repo: git.remoteConfig.name,
+    properties: [
+      {
+        property_name: mergeModePropertyName,
+        value,
+      },
+    ],
+  });
+
+  return true;
+}
+
+async function getRepoConfigValueDefinition(key: string, git: AuthenticatedGitClient) {
+  return git.github.orgs
+    .customPropertiesForReposGetOrganizationDefinition({
+      custom_property_name: key,
+      org: git.remoteConfig.owner,
+    })
+    .then(({data}) => data);
+}