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

feat(dev-infra): prevent deprecations from being merged into patch branch (#42454) 

As per SemVer, deprecations should only be released if the
minor version is incremented. This means that we should error
if commits w/ deprecations target an upcoming patch, LTS release.

Additionally, we also error if deprecations are made as part of
an upcoming release-candidate.

PR Close #42454
This commit is contained in:
Paul Gschwendtner 2021-06-02 19:06:26 +02:00 committed by Andrew Kushnir
parent 107f15df03
commit 97c5a3ae6f
3 changed files with 37 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
dev-infra/ng-dev.js
View File

@ -3453,6 +3453,12 @@ var PullRequestFailure = /** @class */ (function () {
"breaking changes. Breaking changes can only be merged with the \"target: major\" label.";
return new this(message);
};
PullRequestFailure.hasDeprecations = function (label) {
var message = "Cannot merge into branch for \"" + label.pattern + "\" as the pull request " +
"contains deprecations. Deprecations can only be merged with the \"target: minor\" or " +
"\"target: major\" label.";
return new this(message);
};
PullRequestFailure.hasFeatureCommits = function (label) {
var message = "Cannot merge into branch for \"" + label.pattern + "\" as the pull request has " +
'commits with the "feat" type. New features can only be merged with the "target: minor" ' +
@ -3611,15 +3617,13 @@ var PR_SCHEMA$2 = {
/** Fetches a pull request from Github. Returns null if an error occurred. */
function fetchPullRequestFromGithub(git, prNumber) {
return tslib.__awaiter(this, void 0, void 0, function () {
var x, e_1;
var e_1;
return tslib.__generator(this, function (_a) {
switch (_a.label) {
case 0:
_a.trys.push([0, 2, , 3]);
return [4 /*yield*/, getPr(PR_SCHEMA$2, prNumber, git)];
case 1:
x = _a.sent();
return [2 /*return*/, x];
case 1: return [2 /*return*/, _a.sent()];
case 2:
e_1 = _a.sent();
// If the pull request could not be found, we want to return `null` so
@ -3638,8 +3642,9 @@ function isPullRequest(v) {
return v.targetBranches !== undefined;
}
/**
* Assert the commits provided are allowed to merge to the provided target label, throwing a
* PullRequestFailure otherwise.
* Assert the commits provided are allowed to merge to the provided target label,
* throwing an error otherwise.
* @throws {PullRequestFailure}
*/
function assertChangesAllowForTargetLabel(commits, label, config) {
/**
@ -3650,6 +3655,7 @@ function assertChangesAllowForTargetLabel(commits, label, config) {
/** List of commits which are subject to content requirements for the target label. */
commits = commits.filter(function (commit) { return !exemptedScopes.includes(commit.scope); });
var hasBreakingChanges = commits.some(function (commit) { return commit.breakingChanges.length !== 0; });
var hasDeprecations = commits.some(function (commit) { return commit.deprecations.length !== 0; });
var hasFeatureCommits = commits.some(function (commit) { return commit.type === 'feat'; });
switch (label.pattern) {
case 'target: major':
@ -3668,6 +3674,12 @@ function assertChangesAllowForTargetLabel(commits, label, config) {
if (hasFeatureCommits) {
throw PullRequestFailure.hasFeatureCommits(label);
}
// Deprecations should not be merged into RC, patch or LTS branches.
// https://semver.org/#spec-item-7. Deprecations should be part of
// minor releases, or major releases according to SemVer.
if (hasDeprecations) {
throw PullRequestFailure.hasDeprecations(label);
}
break;
default:
warn(red('WARNING: Unable to confirm all commits in the pull request are eligible to be'));
@ -3678,6 +3690,7 @@ function assertChangesAllowForTargetLabel(commits, label, config) {
/**
* Assert the pull request has the proper label for breaking changes if there are breaking change
* commits, and only has the label if there are breaking change commits.
* @throws {PullRequestFailure}
*/
function assertCorrectBreakingChangeLabeling(commits, labels, config) {
/** Whether the PR has a label noting a breaking change. */
@ -3691,7 +3704,10 @@ function assertCorrectBreakingChangeLabeling(commits, labels, config) {
throw PullRequestFailure.missingBreakingChangeCommit();
}
}
/** Assert the pull request is pending, not closed, merged or in draft. */
/**
* Assert the pull request is pending, not closed, merged or in draft.
* @throws {PullRequestFailure} if the pull request is not pending.
*/
function assertPendingState(pr) {
if (pr.isDraft) {
throw PullRequestFailure.isDraft();

7
dev-infra/pr/merge/failures.ts
View File

@ -93,6 +93,13 @@ export class PullRequestFailure {
return new this(message);
}
static hasDeprecations(label: TargetLabel) {
const message = `Cannot merge into branch for "${label.pattern}" as the pull request ` +
`contains deprecations. Deprecations can only be merged with the "target: minor" or ` +
`"target: major" label.`;
return new this(message);
}
static hasFeatureCommits(label: TargetLabel) {
const message = `Cannot merge into branch for "${label.pattern}" as the pull request has ` +
'commits with the "feat" type. New features can only be merged with the "target: minor" ' +

7
dev-infra/pr/merge/pull-request.ts
View File

@ -201,6 +201,7 @@ function assertChangesAllowForTargetLabel(
/** List of commits which are subject to content requirements for the target label. */
commits = commits.filter(commit => !exemptedScopes.includes(commit.scope));
const hasBreakingChanges = commits.some(commit => commit.breakingChanges.length !== 0);
const hasDeprecations = commits.some(commit => commit.deprecations.length !== 0);
const hasFeatureCommits = commits.some(commit => commit.type === 'feat');
switch (label.pattern) {
case 'target: major':
@ -219,6 +220,12 @@ function assertChangesAllowForTargetLabel(
if (hasFeatureCommits) {
throw PullRequestFailure.hasFeatureCommits(label);
}
// Deprecations should not be merged into RC, patch or LTS branches.
// https://semver.org/#spec-item-7. Deprecations should be part of
// minor releases, or major releases according to SemVer.
if (hasDeprecations) {
throw PullRequestFailure.hasDeprecations(label);
}
break;
default:
warn(red('WARNING: Unable to confirm all commits in the pull request are eligible to be'));