From be8ce09ddb16432dd35bf64992a773d5bdce7ff1 Mon Sep 17 00:00:00 2001 From: Isaac Mann Date: Tue, 18 Jan 2022 11:35:41 -0500 Subject: [PATCH] docs(core): add note about buildable libs depending on buildable libs (#8546) Co-authored-by: Isaac Mann --- docs/shared/workspace/buildable-and-publishable-libraries.md | 2 ++ .../shared/workspace/buildable-and-publishable-libraries.md | 2 ++ 2 files changed, 4 insertions(+) diff --git a/docs/shared/workspace/buildable-and-publishable-libraries.md b/docs/shared/workspace/buildable-and-publishable-libraries.md index 17ec856c966ca..297a6d24e71d3 100644 --- a/docs/shared/workspace/buildable-and-publishable-libraries.md +++ b/docs/shared/workspace/buildable-and-publishable-libraries.md @@ -31,4 +31,6 @@ Buildable libraries are similar to "publishable libraries" described above. Thei Buildable libraries are mostly used for producing some pre-compiled output that can be directly referenced from an Nx workspace application without the need to again compile it. A typical scenario is to leverage Nx’s [incremental building](/ci/incremental-builds) capabilities. +> Note: In order for a buildable library to be pre-compiled, it can only depend on other buildable libraries. This allows you to take full advantage of incremental builds. + For more details on the mechanics, remember that Nx is an open source project, so you can see the actual impact of the generator by looking at the source code (the best starting point is probably `packages//src/generators/library/library.ts`). diff --git a/nx-dev/nx-dev/public/documentation/shared/workspace/buildable-and-publishable-libraries.md b/nx-dev/nx-dev/public/documentation/shared/workspace/buildable-and-publishable-libraries.md index 17ec856c966ca..297a6d24e71d3 100644 --- a/nx-dev/nx-dev/public/documentation/shared/workspace/buildable-and-publishable-libraries.md +++ b/nx-dev/nx-dev/public/documentation/shared/workspace/buildable-and-publishable-libraries.md @@ -31,4 +31,6 @@ Buildable libraries are similar to "publishable libraries" described above. Thei Buildable libraries are mostly used for producing some pre-compiled output that can be directly referenced from an Nx workspace application without the need to again compile it. A typical scenario is to leverage Nx’s [incremental building](/ci/incremental-builds) capabilities. +> Note: In order for a buildable library to be pre-compiled, it can only depend on other buildable libraries. This allows you to take full advantage of incremental builds. + For more details on the mechanics, remember that Nx is an open source project, so you can see the actual impact of the generator by looking at the source code (the best starting point is probably `packages//src/generators/library/library.ts`).