f96dcc5ce0
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
72 lines
3.0 KiB
TypeScript
72 lines
3.0 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 {ActiveReleaseTrains} from '../../versioning/active-release-trains';
|
|
import {getLtsNpmDistTagOfMajor} from '../../versioning/long-term-support';
|
|
import {ReleaseAction} from '../actions';
|
|
import {invokeSetNpmDistCommand, invokeYarnInstallCommand} from '../external-commands';
|
|
|
|
/**
|
|
* Release action that cuts a stable version for the current release-train in the release
|
|
* candidate phase. The pre-release release-candidate version label is removed.
|
|
*/
|
|
export class CutStableAction extends ReleaseAction {
|
|
private _newVersion = this._computeNewVersion();
|
|
|
|
async getDescription() {
|
|
const newVersion = this._newVersion;
|
|
return `Cut a stable release for the release-candidate branch (v${newVersion}).`;
|
|
}
|
|
|
|
async perform() {
|
|
const {branchName} = this.active.releaseCandidate!;
|
|
const newVersion = this._newVersion;
|
|
const isNewMajor = this.active.releaseCandidate?.isMajor;
|
|
|
|
|
|
const {id} = await this.checkoutBranchAndStageVersion(newVersion, branchName);
|
|
|
|
await this.waitForPullRequestToBeMerged(id);
|
|
await this.buildAndPublish(newVersion, branchName, 'latest');
|
|
|
|
// If a new major version is published and becomes the "latest" release-train, we need
|
|
// to set the LTS npm dist tag for the previous latest release-train (the current patch).
|
|
if (isNewMajor) {
|
|
const previousPatchVersion = this.active.latest.version;
|
|
const ltsTagForPatch = getLtsNpmDistTagOfMajor(previousPatchVersion.major);
|
|
|
|
// Instead of directly setting the NPM dist tags, we invoke the ng-dev command for
|
|
// setting the NPM dist tag to the specified version. We do this because release NPM
|
|
// packages could be different in the previous patch branch, and we want to set the
|
|
// LTS tag for all packages part of the last major. It would not be possible to set the
|
|
// NPM dist tag for new packages part of the released major, nor would it be acceptable
|
|
// to skip the LTS tag for packages which are no longer part of the new major.
|
|
await invokeYarnInstallCommand(this.projectDir);
|
|
await invokeSetNpmDistCommand(ltsTagForPatch, previousPatchVersion);
|
|
}
|
|
|
|
await this.cherryPickChangelogIntoNextBranch(newVersion, branchName);
|
|
}
|
|
|
|
/** Gets the new stable version of the release candidate release-train. */
|
|
private _computeNewVersion(): semver.SemVer {
|
|
const {version} = this.active.releaseCandidate!;
|
|
return semver.parse(`${version.major}.${version.minor}.${version.patch}`)!;
|
|
}
|
|
|
|
static async isActive(active: ActiveReleaseTrains) {
|
|
// A stable version can be cut for an active release-train currently in the
|
|
// release-candidate phase. Note: It is not possible to directly release from
|
|
// feature-freeze phase into a stable version.
|
|
return active.releaseCandidate !== null &&
|
|
active.releaseCandidate.version.prerelease[0] === 'rc';
|
|
}
|
|
}
|