Skip to content

Commit

Permalink
docs(angular): update incremental builds requirements docs and ng-pac…
Browse files Browse the repository at this point in the history
…kagr-lite description (nrwl#13465)

Fixes nrwl#13421
  • Loading branch information
leosvelperez committed Nov 29, 2022
1 parent 5999dee commit 42fa5d8
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 8 deletions.
4 changes: 2 additions & 2 deletions docs/generated/packages/angular.json
Expand Up @@ -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": [
Expand Down Expand Up @@ -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"
Expand Down
7 changes: 4 additions & 3 deletions docs/shared/guides/setup-incremental-builds-angular.md
Expand Up @@ -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" %}
{
Expand Down
4 changes: 2 additions & 2 deletions packages/angular/executors.json
Expand Up @@ -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",
Expand All @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/angular/src/executors/ng-packagr-lite/schema.json
Expand Up @@ -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": [
Expand Down

0 comments on commit 42fa5d8

Please sign in to comment.