From 42fa5d871b3a812c53ffe06d2834d8dcce836692 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Leosvel=20P=C3=A9rez=20Espinosa?= Date: Tue, 29 Nov 2022 11:39:23 +0100 Subject: [PATCH] docs(angular): update incremental builds requirements docs and ng-packagr-lite description (#13465) Fixes https://github.com/nrwl/nx/issues/13421 --- docs/generated/packages/angular.json | 4 ++-- docs/shared/guides/setup-incremental-builds-angular.md | 7 ++++--- packages/angular/executors.json | 4 ++-- packages/angular/src/executors/ng-packagr-lite/schema.json | 2 +- 4 files changed, 9 insertions(+), 8 deletions(-) diff --git a/docs/generated/packages/angular.json b/docs/generated/packages/angular.json index 5e8f1308b4a97..8f5731ec1b790 100644 --- a/docs/generated/packages/angular.json +++ b/docs/generated/packages/angular.json @@ -2509,7 +2509,7 @@ "outputCapture": "direct-nodejs", "$schema": "http://json-schema.org/schema", "title": "ng-packagr Target", - "description": "ng-packagr target options for Build Architect. Use to build library projects.", + "description": "Builds a library with support for incremental builds.\nThis executor is meant to be used with buildable libraries in an incremental build scenario. It is similar to the `@nrwl/angular:package` executor but with some key differences:\n- It doesn't run `ngcc` automatically (`ngcc` needs to be run separately beforehand if needed, this can be done in a `postinstall` hook on `package.json`).\n- It only produces ESM2020 bundles.\n- It doesn't generate package exports in the `package.json`.", "cli": "nx", "type": "object", "presets": [ @@ -2561,7 +2561,7 @@ "additionalProperties": false, "required": ["project"] }, - "description": "Builds a library with support for incremental builds.", + "description": "Builds a library with support for incremental builds.\nThis executor is meant to be used with buildable libraries in an incremental build scenario. It is similar to the `@nrwl/angular:package` executor but with some key differences:\n- It doesn't run `ngcc` automatically (`ngcc` needs to be run separately beforehand if needed, this can be done in a `postinstall` hook on `package.json`).\n- It only produces ESM2020 bundles.\n- It doesn't generate package exports in the `package.json`.", "aliases": [], "hidden": false, "path": "/packages/angular/src/executors/ng-packagr-lite/schema.json" diff --git a/docs/shared/guides/setup-incremental-builds-angular.md b/docs/shared/guides/setup-incremental-builds-angular.md index 22d0f7b08e4f1..707827942371d 100644 --- a/docs/shared/guides/setup-incremental-builds-angular.md +++ b/docs/shared/guides/setup-incremental-builds-angular.md @@ -9,9 +9,10 @@ Incremental builds requires Nx version 10.4.0 or later. ## Requirements -It’s required that you run the Angular compatibility compiler (`ngcc`) after every package installation if you have Ivy -enabled. This comes configured by default in every Nx workspace. The incremental build relies on the fact that `ngcc` -must have already been run. You can check your `package.json` and make sure you have the following: +If your library consumes any Angular package that has not been compiled with Ivy, you must ensure the +Angular compatibility compiler (`ngcc`) has run before building the library. The incremental build relies +on the fact that `ngcc` must have already been run. One way to do this is to run `ngcc` after every package +installation. You can check your `package.json` and make sure you have the following: ```jsonc {% fileName="package.json" %} { diff --git a/packages/angular/executors.json b/packages/angular/executors.json index 2e263ea4f0d15..188c3831eab2c 100644 --- a/packages/angular/executors.json +++ b/packages/angular/executors.json @@ -8,7 +8,7 @@ "ng-packagr-lite": { "implementation": "./src/executors/ng-packagr-lite/ng-packagr-lite.impl", "schema": "./src/executors/ng-packagr-lite/schema.json", - "description": "Builds a library with support for incremental builds." + "description": "Builds a library with support for incremental builds.\nThis executor is meant to be used with buildable libraries in an incremental build scenario. It is similar to the `@nrwl/angular:package` executor but with some key differences:\n- It doesn't run `ngcc` automatically (`ngcc` needs to be run separately beforehand if needed, this can be done in a `postinstall` hook on `package.json`).\n- It only produces ESM2020 bundles.\n- It doesn't generate package exports in the `package.json`." }, "package": { "implementation": "./src/executors/package/package.impl", @@ -30,7 +30,7 @@ "ng-packagr-lite": { "implementation": "./src/executors/ng-packagr-lite/compat", "schema": "./src/executors/ng-packagr-lite/schema.json", - "description": "Builds a library with support for incremental builds." + "description": "Builds a library with support for incremental builds.\nThis executor is meant to be used with buildable libraries in an incremental build scenario. It is similar to the `@nrwl/angular:package` executor but with some key differences:\n- It doesn't run `ngcc` automatically (`ngcc` needs to be run separately beforehand if needed, this can be done in a `postinstall` hook on `package.json`)\n- It only produces ESM2020 bundles\n- It doesn't generate package exports in the `package.json`" }, "package": { "implementation": "./src/executors/package/compat", diff --git a/packages/angular/src/executors/ng-packagr-lite/schema.json b/packages/angular/src/executors/ng-packagr-lite/schema.json index d92464f278566..8a1233ab7b145 100644 --- a/packages/angular/src/executors/ng-packagr-lite/schema.json +++ b/packages/angular/src/executors/ng-packagr-lite/schema.json @@ -3,7 +3,7 @@ "outputCapture": "direct-nodejs", "$schema": "http://json-schema.org/schema", "title": "ng-packagr Target", - "description": "ng-packagr target options for Build Architect. Use to build library projects.", + "description": "Builds a library with support for incremental builds.\nThis executor is meant to be used with buildable libraries in an incremental build scenario. It is similar to the `@nrwl/angular:package` executor but with some key differences:\n- It doesn't run `ngcc` automatically (`ngcc` needs to be run separately beforehand if needed, this can be done in a `postinstall` hook on `package.json`).\n- It only produces ESM2020 bundles.\n- It doesn't generate package exports in the `package.json`.", "cli": "nx", "type": "object", "presets": [