Function mergePullRequest

ng-dev/pr/merge/merge-pull-request.ts:38–118

(prNumber: number, flags: PullRequestMergeFlags)

 * @param flags Configuration options for merging pull requests.
 */
export async function mergePullRequest(prNumber: number, flags: PullRequestMergeFlags) {
  // Set the environment variable to skip all git commit hooks triggered by husky. We are unable to
  // rely on `--no-verify` as some hooks still run, notably the `prepare-commit-msg` hook.
  process.env['HUSKY'] = '0';

  const tool = await createPullRequestMergeTool(flags);

  // Perform the merge. If the merge fails with non-fatal failures, the script
  // will prompt whether it should rerun in force mode with the ignored failure.
  if (!(await performMerge())) {
    process.exit(1);
  }

  /** Performs the merge and returns whether it was successful or not. */
  async function performMerge(
    validationConfig = {
      assertCompletedReviews: !flags.ignorePendingReviews,
    },
  ): Promise<boolean> {
    try {
      await tool.merge(prNumber, validationConfig);
      return true;
    } catch (e) {
      // Catch errors to the Github API for invalid requests. We want to
      // exit the script with a better explanation of the error.
      if (isGithubApiError(e) && e.status === 401) {
        Log.error('Github API request failed: ' + bold(e.message));
        Log.error('Please ensure that your provided token is valid.');
        Log.warn(`You can generate a token here: ${GITHUB_TOKEN_GENERATE_URL}`);
        return false;
      }
      // Catch errors to the Github API for repository rule violations. We want to
      // exit the script with a better explanation of the error.
      if (
        isGithubApiError(e) &&
        e.status === 405 &&
        e.message.startsWith('Repository rule violations found')
      ) {
        Log.error('  ✘  Repository Rule Violation. This typically indicates that you are not');
        Log.error('     currently a member of the expected group for merge permissions in this');
        Log.error('     repository. Have you been placed in the expected caretaking group?');
        Log.debug('Github API request failed: ' + bold(e.message));
        return false;
      }
      if (isGithubApiError(e)) {
        Log.error('Github API request failed: ' + bold(e.message));
        return false;
      }
      if (e instanceof UserAbortedMergeToolError) {
        Log.warn('Manually aborted merging..');
        return false;
      }
      if (e instanceof InvalidTargetBranchError) {
        Log.error(`Pull request selects an invalid GitHub destination branch:`);
        Log.error(` -> ${bold(e.failureMessage)}`);
      }
      if (e instanceof InvalidTargetLabelError) {
        Log.error(`Pull request target label could not be determined:`);