Creates a tool for staging and publishing releases as per the new branching and versioning that has been outlined in the following document. The tool is intended to be used across the organization to ensure consistent branching/versioning and labeling: https://docs.google.com/document/d/197kVillDwx-RZtSVOBtPb4BBIAw0E9RT3q3v6DZkykU/edit#heading=h.s3qlps8f4zq7dd The tool implements the actions as outlined in the following initial plan: https://hackmd.io/2Le8leq0S6G_R5VEVTNK9A. The implementation slightly diverged in so far that it performs staging and publishing together so that releasing is a single convenient command. In case of errors for which re-running the full command is not sufficient, we want to consider adding recover functionality. e.g. when the staging completed, but the actual NPM publishing aborted unexpectedly due to build errors. PR Close #38656
54 lines
2.1 KiB
TypeScript
54 lines
2.1 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 * as semver from 'semver';
|
|
|
|
import {green, info, yellow} from '../../../utils/console';
|
|
import {ActiveReleaseTrains} from '../../versioning/active-release-trains';
|
|
import {ReleaseAction} from '../actions';
|
|
import {getCommitMessageForNextBranchMajorSwitch} from '../commit-message';
|
|
import {packageJsonPath} from '../constants';
|
|
|
|
/**
|
|
* Release action that configures the active next release-train to be for a major
|
|
* version. This means that major changes can land in the next branch.
|
|
*/
|
|
export class ConfigureNextAsMajorAction extends ReleaseAction {
|
|
private _newVersion = semver.parse(`${this.active.next.version.major + 1}.0.0-next.0`)!;
|
|
|
|
async getDescription() {
|
|
const {branchName} = this.active.next;
|
|
const newVersion = this._newVersion;
|
|
return `Configure the "${branchName}" branch to be released as major (v${newVersion}).`;
|
|
}
|
|
|
|
async perform() {
|
|
const {branchName} = this.active.next;
|
|
const newVersion = this._newVersion;
|
|
|
|
await this.verifyPassingGithubStatus(branchName);
|
|
await this.checkoutUpstreamBranch(branchName);
|
|
await this.updateProjectVersion(newVersion);
|
|
await this.createCommit(
|
|
getCommitMessageForNextBranchMajorSwitch(newVersion), [packageJsonPath]);
|
|
const pullRequest = await this.pushChangesToForkAndCreatePullRequest(
|
|
branchName, `switch-next-to-major-${newVersion}`,
|
|
`Configure next branch to receive major changes for v${newVersion}`);
|
|
|
|
info(green(' ✓ Next branch update pull request has been created.'));
|
|
info(yellow(` Please ask team members to review: ${pullRequest.url}.`));
|
|
}
|
|
|
|
static async isActive(active: ActiveReleaseTrains) {
|
|
// The `next` branch can always be switched to a major version, unless it already
|
|
// is targeting a new major. A major can contain minor changes, so we can always
|
|
// change the target from a minor to a major.
|
|
return !active.next.isMajor;
|
|
}
|
|
}
|