angular-cn/dev-infra/release/versioning/print-active-trains.ts

/**
 * @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 {blue, bold, info} from '../../utils/console';
import {ReleaseConfig} from '../config/index';

import {ActiveReleaseTrains} from './active-release-trains';
import {fetchLongTermSupportBranchesFromNpm} from './long-term-support';
import {isVersionPublishedToNpm} from './npm-registry';

/**
 * Prints the active release trains to the console.
 * @params active Active release trains that should be printed.
 * @params config Release configuration used for querying NPM on published versions.
 */
export async function printActiveReleaseTrains(
    active: ActiveReleaseTrains, config: ReleaseConfig): Promise<void> {
  const {releaseCandidate, next, latest} = active;
  const isNextPublishedToNpm = await isVersionPublishedToNpm(next.version, config);
  const nextTrainType = next.isMajor ? 'major' : 'minor';
  const ltsBranches = await fetchLongTermSupportBranchesFromNpm(config);

  info();
  info(blue('Current version branches in the project:'));

  // Print information for release trains in the feature-freeze/release-candidate phase.
  if (releaseCandidate !== null) {
    const rcVersion = releaseCandidate.version;
    const rcTrainType = releaseCandidate.isMajor ? 'major' : 'minor';
    const rcTrainPhase =
        rcVersion.prerelease[0] === 'next' ? 'feature-freeze' : 'release-candidate';
    info(
        ` • ${bold(releaseCandidate.branchName)} contains changes for an upcoming ` +
        `${rcTrainType} that is currently in ${bold(rcTrainPhase)} phase.`);
    info(`   Most recent pre-release for this branch is "${bold(`v${rcVersion}`)}".`);
  }

  // Print information about the release-train in the latest phase. i.e. the patch branch.
  info(` • ${bold(latest.branchName)} contains changes for the most recent patch.`);
  info(`   Most recent patch version for this branch is "${bold(`v${latest.version}`)}".`);

  // Print information about the release-train in the next phase.
  info(
      ` • ${bold(next.branchName)} contains changes for a ${nextTrainType} ` +
      `currently in active development.`);
  // Note that there is a special case for versions in the next release-train. The version in
  // the next branch is not always published to NPM. This can happen when we recently branched
  // off for a feature-freeze release-train. More details are in the next pre-release action.
  if (isNextPublishedToNpm) {
    info(`   Most recent pre-release version for this branch is "${bold(`v${next.version}`)}".`);
  } else {
    info(
        `   Version is currently set to "${bold(`v${next.version}`)}", but has not been ` +
        `published yet.`);
  }

  // If no release-train in release-candidate or feature-freeze phase is active,
  // we print a message as last bullet point to make this clear.
  if (releaseCandidate === null) {
    info(' • No release-candidate or feature-freeze branch currently active.');
  }

  info();
  info(blue('Current active LTS version branches:'));

  // Print all active LTS branches (each branch as own bullet point).
  if (ltsBranches.active.length !== 0) {
    for (const ltsBranch of ltsBranches.active) {
      info(` • ${bold(ltsBranch.name)} is currently in active long-term support phase.`);
      info(`   Most recent patch version for this branch is "${bold(`v${ltsBranch.version}`)}".`);
    }
  }

  info();
}