iSharkFly-Docs
/
angular-docs-cn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(dev-infra): prompt caretaker to confirm the merge branches on merge (#39333) 

Perviously, it was not immediately clear what branches a PR would merge
into during the merge process.  This prompt allows for caretakers to
understand and acknowledge where the PR will merge to.

PR Close #39333
This commit is contained in:
Joey Perrott 2020-10-15 10:58:51 -07:00 committed by Andrew Kushnir
parent 7e742aea7c
commit 767fdccf59
2 changed files with 16 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
dev-infra/pr/merge/messages.ts
View File

@ -11,5 +11,11 @@ import {PullRequest} from './pull-request';
export function getCaretakerNotePromptMessage(pullRequest: PullRequest): string { export function getCaretakerNotePromptMessage(pullRequest: PullRequest): string {
return red('Pull request has a caretaker note applied. Please make sure you read it.') + return red('Pull request has a caretaker note applied. Please make sure you read it.') +
`\nQuick link to PR: ${pullRequest.url}`; `\nQuick link to PR: ${pullRequest.url}\nDo you want to proceed merging?`;
}
export function getTargettedBranchesConfirmationPromptMessage(pullRequest: PullRequest): string {
const targetBranchListAsString = pullRequest.targetBranches.map(b => ` - ${b}\n`).join('');
return `Pull request #${pullRequest.prNumber} will merge into:\n${
targetBranchListAsString}\nDo you want to proceed merging?`;
} }

13
dev-infra/pr/merge/task.ts
View File

@ -9,9 +9,9 @@
import {promptConfirm} from '../../utils/console'; import {promptConfirm} from '../../utils/console';
import {GitClient, GitCommandError} from '../../utils/git'; import {GitClient, GitCommandError} from '../../utils/git';
import {MergeConfig, MergeConfigWithRemote} from './config'; import {MergeConfigWithRemote} from './config';
import {PullRequestFailure} from './failures'; import {PullRequestFailure} from './failures';
import {getCaretakerNotePromptMessage} from './messages'; import {getCaretakerNotePromptMessage, getTargettedBranchesConfirmationPromptMessage} from './messages';
import {isPullRequest, loadAndValidatePullRequest,} from './pull-request'; import {isPullRequest, loadAndValidatePullRequest,} from './pull-request';
import {GithubApiMergeStrategy} from './strategies/api-merge'; import {GithubApiMergeStrategy} from './strategies/api-merge';
import {AutosquashMergeStrategy} from './strategies/autosquash-merge'; import {AutosquashMergeStrategy} from './strategies/autosquash-merge';
@ -78,11 +78,16 @@ export class PullRequestMergeTask {
return {status: MergeStatus.FAILED, failure: pullRequest}; return {status: MergeStatus.FAILED, failure: pullRequest};
} }
if (!await promptConfirm(getTargettedBranchesConfirmationPromptMessage(pullRequest))) {
return {status: MergeStatus.USER_ABORTED};
}
// If the pull request has a caretaker note applied, raise awareness by prompting // If the pull request has a caretaker note applied, raise awareness by prompting
// the caretaker. The caretaker can then decide to proceed or abort the merge. // the caretaker. The caretaker can then decide to proceed or abort the merge.
if (pullRequest.hasCaretakerNote && if (pullRequest.hasCaretakerNote &&
!await promptConfirm( !await promptConfirm(getCaretakerNotePromptMessage(pullRequest))) {
getCaretakerNotePromptMessage(pullRequest) + `\nDo you want to proceed merging?`)) {
return {status: MergeStatus.USER_ABORTED}; return {status: MergeStatus.USER_ABORTED};
} }