build: switch to release tool from dev-infra

Switches to the release tool from the shared dev-infra
package. This script is more aligned with the versioning
and branching the whole Angular organization follows as this
point.

We work around a couple of APIs that need to be discussed
within the release tool in order to wire up custom release
stage / publish validations. We still want to keep them for
now so we use some monkey-patching (which is acceptable for
the interim until we have determined which checks should be
built-in / how consumers can wire up additional checks)

Author: devversion

.bazelrc

@@ -45,10 +45,10 @@ test --test_output=errors
 
 # Configures script to do version stamping.
 # See https://docs.bazel.build/versions/master/user-manual.html#flag--workspace_status_command
-build:release --workspace_status_command="node ./tools/bazel-stamp-vars.js"
+build:release --workspace_status_command="yarn -s ng-dev release build-env-stamp --mode=release"
 build:release --stamp
 
-build:snapshot-build --workspace_status_command="node ./tools/bazel-stamp-vars.js --snapshot"
+build:snapshot-build --workspace_status_command="yarn -s ng-dev release build-env-stamp --mode=snapshot"
 build:snapshot-build --stamp
 
 ################################

.circleci/config.yml

@@ -386,16 +386,8 @@ jobs:
       - *yarn_install
       - *setup_bazel_binary
 
-      - run: yarn build
-      - run:
-          name: Checking release output
-          command: |
-            pkg_json_version=$(node -pe "require('./package.json').version")
-            expected_version="${pkg_json_version}-sha-$(git rev-parse --short HEAD)"
-            yarn check-release-output ${expected_version}
-      - run:
-          name: Checking tooling scripts
-          command: yarn check-tools
+      - run: yarn build-and-check-release-output
+      - run: yarn check-tools
 
       # TODO(devversion): replace this with bazel tests that run Madge. This is
       # cumbersome and doesn't guarantee no circular deps for other entry-points.

.ng-dev/release.ts

@@ -1,20 +1,66 @@
-import {join} from 'path';
-import {ReleaseConfig} from '@angular/dev-infra-private/release/config';
-import {releasePackages} from '../tools/release/release-output/release-packages';
-import {promptAndGenerateChangelog} from '../tools/release/changelog';
+import {BuiltPackage, ReleaseConfig} from '@angular/dev-infra-private/release/config';
+import {ReleaseAction} from '@angular/dev-infra-private/release/publish/actions';
+import {SemVer} from 'semver';
+
+import {
+  assertValidFrameworkPeerDependency
+} from '../tools/release-checks/check-framework-peer-dependency';
+import {
+  assertValidUpdateMigrationCollections
+} from '../tools/release-checks/check-migration-collections';
+import {assertValidNpmPackageOutput} from '../tools/release-checks/npm-package-output';
+
+const actionProto = ReleaseAction.prototype as any;
+const _origStageFn = actionProto.stageVersionForBranchAndCreatePullRequest;
+const _origVerifyFn = actionProto._verifyPackageVersions;
+
+// Patches the `@angular/dev-infra-private` release tool to perform sanity checks
+// before staging a release. This is temporary until the dev-infra team has implemented
+// a more generic solution to running sanity checks before releasing (potentially building
+// some of the checks we have in the components repository into the release tool).
+actionProto.stageVersionForBranchAndCreatePullRequest = async function(newVersion: SemVer) {
+  await assertValidFrameworkPeerDependency(newVersion);
+  await assertValidUpdateMigrationCollections(newVersion);
+
+  return await _origStageFn.apply(this, arguments);
+};
+
+// Patches the `@angular/dev-infra-private` release tool to perform sanity
+// checks of the NPM package output, before publishing to NPM.
+actionProto._verifyPackageVersions =
+    async function(newVersion: SemVer, builtPackages: BuiltPackage[]) {
+  await assertValidNpmPackageOutput(builtPackages, newVersion);
+
+  return await _origVerifyFn.apply(this, arguments);
+};
+
+/**
+ * Packages that will be published as part of the project.
+ *
+ * Note: The order of packages here will control how sections
+ * appear in the changelog.
+ */
+export const releasePackages = [
+  'cdk',
+  'material',
+  'google-maps',
+  'youtube-player',
+  'cdk-experimental',
+  'material-experimental',
+  'material-moment-adapter',
+  'material-luxon-adapter',
+  'material-date-fns-adapter',
+];
 
 /** Configuration for the `ng-dev release` command. */
 export const release: ReleaseConfig = {
+  releaseNotes: {useReleaseTitle: true, groupOrder: releasePackages},
   publishRegistry: 'https://wombat-dressing-room.appspot.com',
   npmPackages: releasePackages.map(pkg => `@angular/${pkg}`),
   buildPackages: async () => {
-    // The performNpmReleaseBuild function is loaded at runtime as the loading the script causes an
-    // invocation of bazel.
-    const {performNpmReleaseBuild} = require(join(__dirname, '../scripts/build-packages-dist'));
+    // The `performNpmReleaseBuild` function is loaded at runtime as loading of the
+    // script results in an invocation of Bazel for any `yarn ng-dev` command.
+    const {performNpmReleaseBuild} = await import('../scripts/build-packages-dist');
     return performNpmReleaseBuild();
-  },
-  // TODO: This can be removed once there is an org-wide tool for changelog generation.
-  generateReleaseNotesForHead: async () => {
-    await promptAndGenerateChangelog(join(__dirname, '../CHANGELOG.md'));
-  },
+  }
 };

package.json

@@ -15,7 +15,8 @@
   },
   "scripts": {
     "postinstall": "node tools/postinstall/apply-patches.js && ngcc --properties module main --create-ivy-entry-points && node tools/postinstall/update-ngcc-main-fields.js",
-    "build": "node ./scripts/build-packages-dist.js",
+    "build": "ts-node --project scripts/tsconfig.json ./scripts/build-packages-dist.js",
+    "build-and-check-release-output": "ts-node --project scripts/tsconfig.json scripts/build-and-check-release-output.ts",
     "build-docs-content": "node ./scripts/build-docs-content.js",
     "dev-app": "ibazel run //src/dev-app:devserver",
     "test": "node ./scripts/run-component-tests.js",
@@ -26,10 +27,9 @@
     "deploy-dev-app": "node ./scripts/deploy-dev-app.js",
     "breaking-changes": "ts-node --project scripts/tsconfig.json scripts/breaking-changes.ts",
     "gulp": "gulp",
-    "stage-release": "ts-node --project tools/release/tsconfig.json tools/release/stage-release.ts",
-    "publish-release": "ts-node --project tools/release/tsconfig.json tools/release/publish-release.ts",
+    "~~stage-release": "ts-node --project tools/legacy-release/tsconfig.json tools/legacy-release/stage-release.ts",
+    "~~publish-release": "ts-node --project tools/legacy-release/tsconfig.json tools/legacy-release/publish-release.ts",
     "check-entry-point-setup": "node ./scripts/check-entry-point-setup.js",
-    "check-release-output": "ts-node --project tools/release/tsconfig.json tools/release/check-release-output.ts",
     "check-rollup-globals": "ts-node --project scripts/tsconfig.json scripts/check-rollup-globals.ts",
     "changelog": "ts-node --project tools/release/tsconfig.json tools/release/changelog.ts",
     "format": "yarn ng-dev format changed",

scripts/build-and-check-release-output.ts

@@ -0,0 +1,25 @@
+/**
+ * Script that builds the NPM release output for all packages
+ * and runs sanity checks against the NPM package output.
+ */
+
+import {performNpmReleaseBuild} from './build-packages-dist';
+import {assertValidNpmPackageOutput} from '../tools/release-checks/npm-package-output';
+import * as semver from 'semver';
+
+const {version} = require('../package.json');
+
+async function main() {
+  // Build the NPM package artifacts.
+  const builtPackages = performNpmReleaseBuild();
+
+  // Run the release output validation checks.
+  await assertValidNpmPackageOutput(builtPackages, semver.parse(version)!);
+}
+
+main().catch(e => {
+  console.error(e);
+  process.exit(1);
+});
+
+

scripts/build-packages-dist.js renamed to scripts/build-packages-dist.ts

@@ -6,9 +6,10 @@
  * distribution folder within the project.
  */
 
-const {execSync} = require('child_process');
-const {join} = require('path');
-const {chmod, cp, mkdir, rm, set, test} = require('shelljs');
+import {execSync} from 'child_process';
+import {join} from 'path';
+import {BuiltPackage} from '@angular/dev-infra-private/release/config';
+import {chmod, cp, mkdir, rm, set, test} from 'shelljs';
 
 // ShellJS should exit if a command fails.
 set('-e');
@@ -20,7 +21,7 @@ const releaseTargetTag = 'release-package';
 const projectDir = join(__dirname, '../');
 
 /** Command that runs Bazel. */
-const bazelCmd = process.env.BAZEL_COMMAND || `yarn -s bazel`;
+const bazelCmd = process.env.BAZEL_COMMAND || `bazel`;
 
 /** Command that queries Bazel for all release package targets. */
 const queryPackagesCmd =
@@ -43,23 +44,23 @@ if (module === require.main) {
 }
 
 /** Builds the release packages for NPM. */
-function performNpmReleaseBuild() {
+export function performNpmReleaseBuild(): BuiltPackage[] {
   return buildReleasePackages(false, defaultDistPath, /* isSnapshotBuild */ false);
 }
 
 /**
  * Builds the release packages as snapshot build. This means that the current
  * Git HEAD SHA is included in the version (for easier debugging and back tracing).
  */
-function performDefaultSnapshotBuild() {
+export function performDefaultSnapshotBuild(): BuiltPackage[] {
   return buildReleasePackages(false, defaultDistPath, /* isSnapshotBuild */ true);
 }
 
 /**
  * Builds the release packages with the given compile mode and copies
  * the package output into the given directory.
  */
-function buildReleasePackages(useIvy, distPath, isSnapshotBuild) {
+function buildReleasePackages(useIvy, distPath, isSnapshotBuild): BuiltPackage[] {
   console.log('######################################');
   console.log('  Building release packages...');
   console.log(`  Compiling with Ivy: ${useIvy}`);
@@ -109,15 +110,15 @@ function buildReleasePackages(useIvy, distPath, isSnapshotBuild) {
     return {
       name: `@angular/${pkg}`,
       outputPath
-    }
-  })
+    };
+  });
 }
 
 /**
  * Gets the package names of the specified Bazel targets.
- * e.g. //src/material:npm_package -> material
+ * e.g. //src/material:npm_package = material
  */
-function getPackageNamesOfTargets(targets) {
+function getPackageNamesOfTargets(targets: string[]): string[] {
   return targets.map(targetName => {
     const matches = targetName.match(/\/\/src\/(.*):npm_package/);
     if (matches === null) {
@@ -128,13 +129,11 @@ function getPackageNamesOfTargets(targets) {
   });
 }
 
-/**
- * Executes the given command in the project directory.
- * @param {string} command The command to run
- * @param {boolean=} captureStdout Whether the stdout should be captured and
- *   returned.
- */
-function exec(command, captureStdout) {
+/** Executes the given command in the project directory. */
+function exec(command: string): void;
+/** Executes the given command in the project directory and returns its stdout. */
+function exec(command: string, captureStdout: true): string;
+function exec(command: string, captureStdout?: boolean) {
   const stdout = execSync(command, {
     cwd: projectDir,
     stdio: ['inherit', captureStdout ? 'pipe' : 'inherit', 'inherit'],

tools/bazel-stamp-vars.js

@@ -32,8 +32,6 @@ const orderedChangelogPackages = [
   'google-maps',
   'youtube-player',
   'material-moment-adapter',
-  'material-luxon-adapter',
-  'material-date-fns-adapter',
   'cdk-experimental',
   'material-experimental',
 ];

tools/release/base-release-task.ts renamed to tools/legacy-release/base-release-task.ts

@@ -1,7 +1,7 @@
 import * as chalk from 'chalk';
 import {join} from 'path';
-import {checkReleasePackage} from './release-output/check-package';
-import {releasePackages} from './release-output/release-packages';
+import {checkReleasePackage} from '../release-checks/npm-package-output/check-package';
+import {releasePackages} from '../../.ng-dev/release';
 
 /**
  * Checks the release output by running the release-output validations for each

tools/release/changelog-commit-template.hbs renamed to tools/legacy-release/changelog-commit-template.hbs

@@ -10,13 +10,10 @@ import {getGithubNewReleaseUrl} from './git/github-urls';
 import {npmPublish} from './npm/npm-client';
 import {promptForNpmDistTag} from './prompt/npm-dist-tag-prompt';
 import {promptForUpstreamRemote} from './prompt/upstream-remote-prompt';
-import {releasePackages} from './release-output/release-packages';
 import {CHANGELOG_FILE_NAME} from './stage-release';
 import {parseVersionName, Version} from './version-name/parse-version';
-
-// The package builder script is not written in TypeScript and needs to
-// be imported through a CommonJS import.
-const {performNpmReleaseBuild} = require('../../scripts/build-packages-dist');
+import {performNpmReleaseBuild} from '../../scripts/build-packages-dist';
+import {releasePackages} from '../../.ng-dev/release';
 
 /**
  * Class that can be instantiated in order to create a new release. The tasks requires user
@@ -36,9 +33,6 @@ class PublishReleaseTask extends BaseReleaseTask {
   /** Path to the release output of the project. */
   releaseOutputPath: string;
 
-  /** Instance of a wrapper that can execute Git commands. */
-  git: GitClient;
-
   constructor(public projectDir: string,
               public repositoryOwner: string,
               public repositoryName: string) {

tools/release/changelog-root-template.hbs renamed to tools/legacy-release/changelog-root-template.hbs

@@ -7,9 +7,10 @@ import {promptAndGenerateChangelog} from './changelog';
 import {GitClient} from './git/git-client';
 import {getGithubBranchCommitsUrl} from './git/github-urls';
 import {promptForNewVersion} from './prompt/new-version-prompt';
-import {checkPackageJsonMigrations} from './release-output/output-validations';
-import {releasePackages} from './release-output/release-packages';
 import {parseVersionName, Version} from './version-name/parse-version';
+import {releasePackages} from '../../.ng-dev/release';
+import {checkPackageJsonMigrations} from '../release-checks/check-migration-collections';
+import * as semver from 'semver';
 
 /** Default filename for the changelog. */
 export const CHANGELOG_FILE_NAME = 'CHANGELOG.md';
@@ -46,9 +47,6 @@ class StageReleaseTask extends BaseReleaseTask {
   /** Parsed current version of the project. */
   currentVersion: Version;
 
-  /** Instance of a wrapper that can execute Git commands. */
-  git: GitClient;
-
   /** Octokit API instance that can be used to make Github API calls. */
   githubApi: Octokit;
 
@@ -253,8 +251,8 @@ class StageReleaseTask extends BaseReleaseTask {
     const failures: string[] = [];
     releasePackages.forEach(packageName => {
       failures.push(...checkPackageJsonMigrations(
-                        join(this.packagesDir, packageName, 'package.json'), newVersion)
-                        .map(f => chalk.yellow(`       ⮑  ${chalk.bold(packageName)}: ${f}`)));
+          join(this.packagesDir, packageName, 'package.json'), semver.parse(newVersion.format())!)
+          .map(f => chalk.yellow(`       ⮑  ${chalk.bold(packageName)}: ${f}`)));
     });
     if (failures.length) {
       console.error(chalk.red(`  ✘   Failures in ng-update migration collection detected:`));

tools/release/changelog.ts renamed to tools/legacy-release/changelog.ts

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "outDir": "../../dist/tools/release",
+    "target": "esnext",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "lib": ["es2016"],
+    "types": ["node"],
+    "strictNullChecks": true,
+    "skipLibCheck": true
+  }
+}