build: adjust peer dependency to include all minor pre-releases (#26421)

Pre-release versions of Angular Material should be compatible with
the same pre-release versions of FW (being worked on at the same time).

Additionally we want to expand the peer dependency so that the
pre-release Material version is also compatible future pre-release
of framework. e.g. consider the scenario where Angular framework
already released `15.2.0-next.0`, while both CLI and COMP are still
on `15.1.0-next.0`.

CLI in this case want to depend on the latest
versions, but with the recent stricter NPM version this would break
as Material wouldn't allow `v15.2.0-next.0`

We switch to a more simpler model that requires less changes by
the caretaker. For `@next` releases we will be more flexible and
allow for all pre-releases of the current major and (N+1)-next/rc

Also we no longer require the peer dep to be updated manually.

This simplifies the caretaker experience as the peer dependency
would no longer need to be updated manually every time the
release version changes.

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="yarn -s ng-dev release build-env-stamp --mode=release"
+build:release --workspace_status_command="yarn -s ng-dev:stamp --mode=release"
 build:release --stamp
 
-build:snapshot-build --workspace_status_command="yarn -s ng-dev release build-env-stamp --mode=snapshot"
+build:snapshot-build --workspace_status_command="yarn -s ng-dev:stamp --mode=snapshot"
 build:snapshot-build --stamp
 
 ####################################

.ng-dev/release.mts

@@ -1,6 +1,5 @@
 import semver from 'semver';
 import {ReleaseConfig} from '@angular/ng-dev';
-import {assertValidFrameworkPeerDependency} from '../tools/release-checks/check-framework-peer-dependency.mjs';
 import {assertValidUpdateMigrationCollections} from '../tools/release-checks/check-migration-collections.mjs';
 import {assertValidNpmPackageOutput} from '../tools/release-checks/npm-package-output/index.mjs';
 
@@ -52,7 +51,6 @@ export const release: ReleaseConfig = {
   prereleaseCheck: async (newVersionStr, builtPackagesWithInfo) => {
     const newVersion = new semver.SemVer(newVersionStr);
 
-    await assertValidFrameworkPeerDependency(newVersion);
     await assertValidUpdateMigrationCollections(newVersion);
     await assertValidNpmPackageOutput(builtPackagesWithInfo, newVersion);
   },

package.json

@@ -16,6 +16,7 @@
   "scripts": {
     "postinstall": "node tools/postinstall/apply-patches.js",
     "ng-dev": "cross-env TS_NODE_PROJECT=$PWD/.ng-dev/tsconfig.json TS_NODE_TRANSPILE_ONLY=1 node --no-warnings --loader ts-node/esm node_modules/@angular/ng-dev/bundles/cli.mjs",
+    "ng-dev:stamp": "yarn -s ng-dev release build-env-stamp --additional-stamping-script=tools/bazel-additional-stamp.mjs",
     "build": "ts-node --esm --project scripts/tsconfig.json ./scripts/build-packages-dist-main.mts",
     "build-docs-content": "ts-node --esm --project scripts/tsconfig.json ./scripts/build-docs-content-main.mts",
     "build-and-check-release-output": "ts-node --esm --project scripts/tsconfig.json scripts/build-and-check-release-output.mts",
@@ -77,7 +78,7 @@
     "@angular/cli": "^15.1.0-rc.0",
     "@angular/compiler-cli": "^15.1.0-rc.0",
     "@angular/localize": "^15.1.0-rc.0",
-    "@angular/ng-dev": "https://github.com/angular/dev-infra-private-ng-dev-builds.git#20d1bd232100d278c53820226427039f51881d3f",
+    "@angular/ng-dev": "https://github.com/angular/dev-infra-private-ng-dev-builds.git#757a386a63e960c4006efd26482f0d52dd0a1604",
     "@angular/platform-browser-dynamic": "^15.1.0-rc.0",
     "@angular/platform-server": "^15.1.0-rc.0",
     "@angular/router": "^15.1.0-rc.0",

packages.bzl

@@ -1,7 +1,6 @@
 # Each individual package uses a placeholder for the version of Angular to ensure they're
 # all in-sync. This map is passed to each ng_package rule to stamp out the appropriate
 # version for the placeholders.
-ANGULAR_PACKAGE_VERSION = "^15.0.0 || ^16.0.0"
 MDC_PACKAGE_VERSION = "15.0.0-canary.fd95ca7ef.0"
 TSLIB_PACKAGE_VERSION = "^2.3.0"
 RXJS_PACKAGE_VERSION = "^6.5.3 || ^7.4.0"
@@ -12,8 +11,8 @@ RXJS_PACKAGE_VERSION = "^6.5.3 || ^7.4.0"
 NPM_PACKAGE_SUBSTITUTIONS = {
     # Version of `material-components-web`
     "0.0.0-MDC": MDC_PACKAGE_VERSION,
-    # Version of `@angular/core`
-    "0.0.0-NG": ANGULAR_PACKAGE_VERSION,
+    # Peer dependency version on the Angular framework.
+    "0.0.0-NG": "{STABLE_FRAMEWORK_PEER_DEP_RANGE}",
     # Version of `tslib`
     "0.0.0-TSLIB": TSLIB_PACKAGE_VERSION,
     # Version of the local package being built, generated via the `--workspace_status_command` flag.
@@ -26,6 +25,7 @@ NO_STAMP_NPM_PACKAGE_SUBSTITUTIONS = dict(NPM_PACKAGE_SUBSTITUTIONS, **{
     # When building NPM packages for tests (where stamping is disabled),
     # we use `0.0.0` for the version placeholder.
     "0.0.0-PLACEHOLDER": "0.0.0",
+    "0.0.0-NG": ">=0.0.0",
 })
 
 # List of MDC packages (used for package externals and for Sass target deps)

scripts/docs-deploy/deploy-ci-push.mts

@@ -3,7 +3,7 @@
 import {
   ActiveReleaseTrains,
   getBranchesForMajorVersions,
-  getVersionForVersionBranch,
+  convertVersionBranchToSemVer,
   isVersionBranch,
 } from '@angular/ng-dev';
 import {firebaseConfig, sites} from './utils.mjs';
@@ -90,7 +90,7 @@ async function main() {
     return;
   }
 
-  const branchVersion = getVersionForVersionBranch(branchName)!;
+  const branchVersion = convertVersionBranchToSemVer(branchName)!;
   const branchMajor = branchVersion.major;
   const branchesForMajor = await getBranchesForMajorVersions(repo, [branchMajor]);
 

tools/bazel-additional-stamp.mjs

@@ -0,0 +1,54 @@
+/**
+ * @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 fs from 'fs';
+import path from 'path';
+import url from 'url';
+import semver from 'semver';
+
+/** Custom stamping on top of the default `ng-dev` release stamping. */
+export default async function (mode) {
+  const scriptDir = path.dirname(url.fileURLToPath(import.meta.url));
+  const projectDir = path.join(scriptDir, '../');
+  const packageJsonRaw = await fs.promises.readFile(path.join(projectDir, 'package.json'));
+  const {version: versionRaw} = JSON.parse(packageJsonRaw);
+  const version = semver.parse(versionRaw);
+
+  console.info(`STABLE_FRAMEWORK_PEER_DEP_RANGE ${computeFrameworkPeerDependency(version)}`);
+}
+
+/**
+ * Computes the Angular peer dependency range. The following rules apply:
+ *
+ *   `N.x.x` requires Angular `^N.0.0 || ^(N+1).0.0`
+ *   `N.x.x-x` requires Angular `^N.0.0-0 || ^N.1.0-0 || ^N.2.0-0 || ^N.3.0-0 || ^(N+1).0.0-0`
+ *
+ * The rationale is that we want to satisfy peer dependencies if we are publishing
+ * pre-releases for a major while Angular framework cuts pre-releases as well. e.g.
+ * Angular CDK v14.0.0-rc.1 should also work with `@angular/core@v14.0.0-rc.1`.
+ *
+ * Note: When we cut pre-releases, the peer dependency includes all anticipated
+ * pre-releases because a range like `^15.0.0-0` itself would not allow for future minor
+ * releases like `15.1.0-next.0`. NPM requires the explicit minors pre-release ranges.
+ *
+ * @param {semver.SemVer} version Current project version.
+ * @returns {string} The NPM peer dependency for depending on framework.
+ */
+function computeFrameworkPeerDependency(version) {
+  if (version.prerelease[0] !== undefined) {
+    return (
+      `^${version.major}.0.0-0 || ` +
+      `^${version.major}.1.0-0 || ` +
+      `^${version.major}.2.0-0 || ` +
+      `^${version.major}.3.0-0 || ` +
+      `^${version.major + 1}.0.0-0`
+    );
+  }
+
+  return `^${version.major}.0.0 || ^${version.major + 1}.0.0`;
+}

tools/release-checks/check-framework-peer-dependency.mts

@@ -373,12 +373,12 @@
     glob "8.0.3"
     yargs "^17.2.1"
 
-"@angular/ng-dev@https://github.com/angular/dev-infra-private-ng-dev-builds.git#20d1bd232100d278c53820226427039f51881d3f":
-  version "0.0.0-0a49ed85541ecbb28a0e19eefce7a874c1eaab5e"
-  resolved "https://github.com/angular/dev-infra-private-ng-dev-builds.git#20d1bd232100d278c53820226427039f51881d3f"
+"@angular/ng-dev@https://github.com/angular/dev-infra-private-ng-dev-builds.git#757a386a63e960c4006efd26482f0d52dd0a1604":
+  version "0.0.0-668a07a6f07d0a75f530728f77da8e3c78f0374a"
+  resolved "https://github.com/angular/dev-infra-private-ng-dev-builds.git#757a386a63e960c4006efd26482f0d52dd0a1604"
   dependencies:
     "@yarnpkg/lockfile" "^1.1.0"
-    typescript "~4.8.0"
+    typescript "~4.9.0"
 
 "@angular/platform-browser-dynamic@^15.1.0-rc.0":
   version "15.1.0-rc.0"
@@ -15565,7 +15565,7 @@ typescript@^3.9.10, typescript@^3.9.5, typescript@^3.9.7:
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.9.10.tgz#70f3910ac7a51ed6bef79da7800690b19bf778b8"
   integrity sha512-w6fIxVE/H1PkLKcCPsFqKE7Kv7QUwhU8qQY2MueZXWx5cPZdwFupLgKK3vntcK98BtNHZtAF4LA/yl2a7k8R6Q==
 
-typescript@~4.5.4, typescript@~4.8.0, typescript@~4.9.3:
+typescript@~4.5.4, typescript@~4.8.0, typescript@~4.9.0, typescript@~4.9.3:
   version "4.9.4"
   resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.4.tgz#a2a3d2756c079abda241d75f149df9d561091e78"
   integrity sha512-Uz+dTXYzxXXbsFpM86Wh3dKCxrQqUcVMxwU54orwlJjOpO3ao8L7j5lH+dWfTwgCwIuM9GQ2kvVotzYJMXTBZg==