6f0f0d3ea2
The merge tool provides a way for configurations to determine the branches for a label lazily. This is supported because it allows labels to respect the currently selected base branch through the Github UI. e.g. if `target: label` is applied on a PR and the PR is based on the patch branch, then the change could only go into the selected target branch, while if it would be based on `master`, the change would be cherry-picked to `master` too. This allows for convenient back-porting of changes if they did not apply cleanly to the primary development branch (`master`). We want to expand this function so that it is possible to report failures if an invalid target label is appplied (e.g. `target: major` not allowed in some situations), or if the Github base branch is not valid for the given target label (e.g. if `target: lts` is used, but it's not based on a LTS branch). PR Close #38223
51 lines
1.6 KiB
TypeScript
51 lines
1.6 KiB
TypeScript
/**
|
|
* @license
|
|
* Copyright Google LLC All Rights Reserved.
|
|
*
|
|
* 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 {MergeConfig, TargetLabel} from './config';
|
|
import {matchesPattern} from './string-pattern';
|
|
|
|
/**
|
|
* Unique error that can be thrown in the merge configuration if an
|
|
* invalid branch is targeted.
|
|
*/
|
|
export class InvalidTargetBranchError {
|
|
constructor(public failureMessage: string) {}
|
|
}
|
|
|
|
/**
|
|
* Unique error that can be thrown in the merge configuration if an
|
|
* invalid label has been applied to a pull request.
|
|
*/
|
|
export class InvalidTargetLabelError {
|
|
constructor(public failureMessage: string) {}
|
|
}
|
|
|
|
/** Gets the target label from the specified pull request labels. */
|
|
export function getTargetLabelFromPullRequest(config: MergeConfig, labels: string[]): TargetLabel|
|
|
null {
|
|
for (const label of labels) {
|
|
const match = config.labels.find(({pattern}) => matchesPattern(label, pattern));
|
|
if (match !== undefined) {
|
|
return match;
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Gets the branches from the specified target label.
|
|
*
|
|
* @throws {InvalidTargetLabelError} Invalid label has been applied to pull request.
|
|
* @throws {InvalidTargetBranchError} Invalid Github target branch has been selected.
|
|
*/
|
|
export async function getBranchesFromTargetLabel(
|
|
label: TargetLabel, githubTargetBranch: string): Promise<string[]> {
|
|
return typeof label.branches === 'function' ? await label.branches(githubTargetBranch) :
|
|
await label.branches;
|
|
}
|