docs(core): rename distributed cache to remote cache (#21061)
This commit is contained in:
Isaac Mann
GitHub
parent
b9192cdcf2
commit
595a7743b6
@ -123,7 +123,7 @@ Enable the App Router for Next.js
|
||||
|
||||
Type: `boolean`
|
||||
|
||||
Enable distributed caching to make your CI faster
|
||||
Enable remote caching to make your CI faster
|
||||
|
||||
### packageManager
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
title: 'init - CLI command'
|
||||
description: 'Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx.'
|
||||
description: 'Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up remote caching. For more info, check https://nx.dev/recipes/adopting-nx.'
|
||||
---
|
||||
|
||||
# init
|
||||
|
||||
Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx.
|
||||
Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up remote caching. For more info, check https://nx.dev/recipes/adopting-nx.
|
||||
|
||||
## Usage
|
||||
|
||||
@ -59,7 +59,7 @@ When false disables interactive input prompts for options.
|
||||
|
||||
Type: `boolean`
|
||||
|
||||
Set up distributed caching with Nx Cloud.
|
||||
Set up remote caching with Nx Cloud.
|
||||
|
||||
### useDotNxInstallation
|
||||
|
||||
|
||||
@ -123,7 +123,7 @@ Enable the App Router for Next.js
|
||||
|
||||
Type: `boolean`
|
||||
|
||||
Enable distributed caching to make your CI faster
|
||||
Enable remote caching to make your CI faster
|
||||
|
||||
### packageManager
|
||||
|
||||
|
||||
@ -1,11 +1,11 @@
|
||||
---
|
||||
title: 'init - CLI command'
|
||||
description: 'Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx.'
|
||||
description: 'Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up remote caching. For more info, check https://nx.dev/recipes/adopting-nx.'
|
||||
---
|
||||
|
||||
# init
|
||||
|
||||
Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx.
|
||||
Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up remote caching. For more info, check https://nx.dev/recipes/adopting-nx.
|
||||
|
||||
## Usage
|
||||
|
||||
@ -59,7 +59,7 @@ When false disables interactive input prompts for options.
|
||||
|
||||
Type: `boolean`
|
||||
|
||||
Set up distributed caching with Nx Cloud.
|
||||
Set up remote caching with Nx Cloud.
|
||||
|
||||
### useDotNxInstallation
|
||||
|
||||
|
||||
@ -2,7 +2,7 @@
|
||||
|
||||
## Why do users need access?
|
||||
|
||||
While just adding an Nx Cloud access token to your monorepo gives you distributed caching and distributed tasks
|
||||
While just adding an Nx Cloud access token to your monorepo gives you remote caching and distributed tasks
|
||||
execution, the Nx Cloud web app gives you analytics about tasks running in your workspace, allows devs to easily inspect
|
||||
terminal output, and works seamlessly with our GitHub integration for your Pull Requests. Here is
|
||||
a [video walkthrough of this](https://youtu.be/GT7XIwG1i5A?t=409).
|
||||
|
||||
@ -315,7 +315,7 @@ Reducing the number of tasks to run via [affected commands](/ci/features/affecte
|
||||
```{% command="pnpm nx connect" %}
|
||||
$ nx g nx:connect-to-nx-cloud --quiet --no-interactive
|
||||
|
||||
> NX Distributed caching via Nx Cloud has been enabled
|
||||
> NX Remote caching via Nx Cloud has been enabled
|
||||
|
||||
In addition to the caching, Nx Cloud provides config-free distributed execution,
|
||||
UI for viewing complex runs and GitHub integration. Learn more at https://nx.app
|
||||
|
||||
@ -315,7 +315,7 @@ Reducing the number of tasks to run via [affected commands](/ci/features/affecte
|
||||
|
||||
```{% command="pnpm nx connect" %}
|
||||
|
||||
> NX Distributed caching via Nx Cloud has been enabled
|
||||
> NX Remote caching via Nx Cloud has been enabled
|
||||
|
||||
In addition to the caching, Nx Cloud provides config-free distributed execution,
|
||||
UI for viewing complex runs and GitHub integration. Learn more at https://nx.app
|
||||
|
||||
@ -38,7 +38,7 @@ Run the command `npx create-nx-workspace@latest` and when prompted, provide the
|
||||
✔ Default stylesheet format · css
|
||||
✔ Would you like to use Standalone Components in your application? · No
|
||||
✔ Would you like to add routing? · Yes
|
||||
✔ Enable distributed caching to make your CI faster · Yes
|
||||
✔ Enable remote caching to make your CI faster · Yes
|
||||
```
|
||||
|
||||
{% card title="Opting into Nx Cloud" description="You will also be prompted whether to add Nx Cloud to your workspace. We won't address this in this tutorial, but you can see the introduction to Nx Cloud for more details." url="/ci/intro/ci-with-nx" /%}
|
||||
|
||||
@ -40,13 +40,13 @@ Create a new Angular application with the following command:
|
||||
✔ Default stylesheet format · css
|
||||
✔ Do you want to enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering)? · No
|
||||
✔ Test runner to use for end to end (E2E) tests · cypress
|
||||
✔ Enable distributed caching to make your CI faster · Yes
|
||||
✔ Enable remote caching to make your CI faster · Yes
|
||||
```
|
||||
|
||||
You get asked a few questions that help Nx preconfigure your new Angular application. These include
|
||||
|
||||
- Angular specific questions, such as which bundler to use, whether to enable server-side rendering and which stylesheet format to use
|
||||
- General Nx questions, such as whether to enable distributed caching with Nx Cloud. Nx comes with built-in [local caching](/core-features/cache-task-results). If you want to benefit from this cache in CI, you can enable [distributed caching](/ci/features/remote-cache) which will set up [Nx Cloud](https://nx.app). This is also a prerequisite for enabling [distributed task execution](/ci/features/distribute-task-execution).
|
||||
- General Nx questions, such as whether to enable remote caching with Nx Cloud. Nx comes with built-in [local caching](/core-features/cache-task-results). If you want to benefit from this cache in CI, you can enable [remote caching](/ci/features/remote-cache) which will set up [Nx Cloud](https://nx.app). This is also a prerequisite for enabling [distributed task execution](/ci/features/distribute-task-execution).
|
||||
|
||||
For the sake of this tutorial, let's respond to all the questions with the default response.
|
||||
|
||||
|
||||
@ -59,7 +59,7 @@ Create a new Angular monorepo with the following command:
|
||||
✔ Default stylesheet format · css
|
||||
✔ Do you want to enable Server-Side Rendering (SSR) and Static Site Generation (SSG/Prerendering)? · No
|
||||
✔ Test runner to use for end to end (E2E) tests · cypress
|
||||
✔ Enable distributed caching to make your CI faster · Yes
|
||||
✔ Enable remote caching to make your CI faster · Yes
|
||||
```
|
||||
|
||||
Let's name the initial application `angular-store`. In this tutorial we're going to use `cypress` for e2e tests and `css` for styling. The above command generates the following structure:
|
||||
|
||||
@ -15,7 +15,7 @@ tasks can start right away.
|
||||
|
||||
The problem with the binning approach is you'll end up with some idle time on one or more jobs. Nx's distributed task
|
||||
execution reduces that idle time to the minimum possible by assigning each individual task to agent jobs based on the
|
||||
task's average run time. Nx also guarantees that tasks are executed in the correct order and uses distributed caching to
|
||||
task's average run time. Nx also guarantees that tasks are executed in the correct order and uses remote caching to
|
||||
make sure that build artifacts from previous tasks are present on every agent job that needs them.
|
||||
|
||||
When you set up Nx's distributed task execution, your task graph will look more like this:
|
||||
@ -23,7 +23,7 @@ When you set up Nx's distributed task execution, your task graph will look more
|
||||
|
||||
|
||||
And not only will CI finish faster, but the debugging experience is the same as if you ran all of your CI on a single
|
||||
job. That's because Nx uses distributed caching to recreate all of the logs and build artifacts on the main job.
|
||||
job. That's because Nx uses remote caching to recreate all of the logs and build artifacts on the main job.
|
||||
|
||||
Find more information in this [guide to parallelization and distribution in CI](/ci/concepts/parallelization-distribution).
|
||||
|
||||
@ -143,7 +143,7 @@ build, they will start running tests and lints. The result is better agent utili
|
||||
|
||||
## CI/CD Examples
|
||||
|
||||
The examples below show how to set up CI using Nx and Nx Cloud using distributed task execution and distributed caching.
|
||||
The examples below show how to set up CI using Nx and Nx Cloud using distributed task execution and remote caching.
|
||||
|
||||
Every organization manages their CI/CD pipelines differently, so the examples don't cover org-specific aspects of
|
||||
CI/CD (e.g., deployment). They mainly focus on configuring Nx correctly.
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Use Remote Caching
|
||||
|
||||
By default Nx [caches task computations locally](/core-features/cache-task-results). However, to benefit from the cache across your team and in particular on CI, the computation cache can also be distributed across multiple machines. Nx Cloud is an app that provides a fast and zero-config implementation of distributed caching. It is a commercial add-on to Nx, is completely free for OSS projects and comes with generous plans for startups and dedicated offerings for enterprise customers ([read more here](https://nx.app/pricing)).
|
||||
By default Nx [caches task computations locally](/core-features/cache-task-results). However, to benefit from the cache across your team and in particular on CI, the computation cache can also be distributed across multiple machines. Nx Cloud is an app that provides a fast and zero-config implementation of remote caching. It is a commercial add-on to Nx, is completely free for OSS projects and comes with generous plans for startups and dedicated offerings for enterprise customers ([read more here](https://nx.app/pricing)).
|
||||
|
||||
|
||||
|
||||
|
||||
@ -70,7 +70,7 @@ These examples have fully
|
||||
functioning [CI](https://github.com/nrwl/react-module-federation/blob/main/.github/workflows/ci.yml) [workflows](https://github.com/nrwl/ng-module-federation/blob/main/.github/workflows/ci.yml)
|
||||
that are simple to set up. You can see what the CI does by viewing the sample pull requests in each repo. Also notice
|
||||
the [Nx Cloud](https://nx.app) integration, which gives you insight into each pipeline. We'll touch on
|
||||
this [later in this guide](#distributed-computation-caching-with-nx-cloud).
|
||||
this [later in this guide](#remote-computation-caching-with-nx-cloud).
|
||||
|
||||
|
||||
|
||||
@ -82,9 +82,9 @@ npx create-nx-workspace acme --preset=apps
|
||||
cd acme
|
||||
```
|
||||
|
||||
{% callout type="check" title="Enabling distributed caching" %}
|
||||
{% callout type="check" title="Enabling remote caching" %}
|
||||
You will be prompted to enable Nx Cloud in the workspace. For the best experience, we highly recommend using Nx Cloud to
|
||||
take advantage of distributed caching and other features it provides.
|
||||
take advantage of remote caching and other features it provides.
|
||||
{% /callout %}
|
||||
|
||||
Then, for React users, install the `@nx/react` plugin; and for Angular users, install the `@nx/angular` plugin.
|
||||
@ -290,7 +290,7 @@ If you have any feedback regarding this feature, we'd love to hear from you--che
|
||||
our [community page](https://nx.dev/community) for links to our Discord and Twitter.
|
||||
{% /callout %}
|
||||
|
||||
## Distributed computation caching with Nx Cloud
|
||||
## Remote computation caching with Nx Cloud
|
||||
|
||||
To use Module Federation well, we recommend that you enable [Nx Cloud](https://nx.app). If you haven't enabled it yet
|
||||
when using `create-nx-workspace`, you can do the following.
|
||||
@ -300,7 +300,7 @@ nx connect-to-nx-cloud
|
||||
```
|
||||
|
||||
With Nx Cloud enabled, a large set of builds can be skipped entirely when running the application locally (and in
|
||||
CI/CD). When you run builds through Nx + Nx Cloud, the artifacts are stored in the distributed cache, so as long as the
|
||||
CI/CD). When you run builds through Nx + Nx Cloud, the artifacts are stored in the remote cache, so as long as the
|
||||
source of a given remote hasn't changed, it will be served from cache.
|
||||
|
||||
You can see this behavior locally if you serve the `host` twice.
|
||||
@ -331,7 +331,7 @@ If you inspect the terminal output, you'll see something like this, even if you
|
||||
```
|
||||
|
||||
{% callout type="note" title="More details" %}
|
||||
This caching behavior is _crucial_. If you don't have a build system supporting distributed computation caching, using
|
||||
This caching behavior is _crucial_. If you don't have a build system supporting remote computation caching, using
|
||||
Module Federation will be slower. It takes longer to build `shop`, `cart` and `about` separately than building all of
|
||||
them together as part of the same process.
|
||||
|
||||
@ -384,7 +384,7 @@ export default withModuleFederation({
|
||||
|
||||
Now you can run `nx build host` to build all the `host` and all the implicit dependencies in production mode.
|
||||
|
||||
{% callout type="note" title="Distributed caching" %}
|
||||
{% callout type="note" title="Remote caching" %}
|
||||
Again, if you don't use [Nx Cloud's Distributed Tasks Execution](/ci/features/distribute-task-execution) using Module Federation will be slower
|
||||
than building everything in a single process. It's only if you enable Distributed Tasks Execution, your CI will be able
|
||||
to build each remote on a separate machine, in parallel, (or not build it at all and retrieve it from cache), which will
|
||||
@ -459,7 +459,7 @@ guide showed how to use it to speed up your builds.
|
||||
|
||||
Module Federation allows you to split a single build process into multiple processes which can run in parallel or even
|
||||
on multiple machines. The result of each build process can be cached independently. For this to work well in practice
|
||||
you need to have a build system supporting distributed computation caching and distributed tasks execution (e.g., Nx +
|
||||
you need to have a build system supporting remote computation caching and distributed tasks execution (e.g., Nx +
|
||||
Nx Cloud).
|
||||
|
||||
When a developer runs say `nx serve host --devRemotes=cart`, they still run the whole application, but `shop`
|
||||
|
||||
@ -43,7 +43,7 @@ Here's a quick side-by-side overview comparing the features between the Angular
|
||||
| [Running Tasks in Parallel](/recipes/running-tasks/run-tasks-in-parallel) | ❌ | ✅ |
|
||||
| Building, Testing [Only What is Affected](/core-features/run-tasks#run-tasks-on-projects-affected-by-a-pr) | ❌ | ✅ |
|
||||
| [Local Caching](/core-features/cache-task-results) | ❌\*\* | ✅ |
|
||||
| [Distributed Caching](/ci/features/remote-cache) | ❌ | ✅ |
|
||||
| [Remote Caching](/ci/features/remote-cache) | ❌ | ✅ |
|
||||
| [Distributed Task Execution on CI](/ci/features/distribute-task-execution) | ❌ | ✅ |
|
||||
| Custom Hashers | ❌ | ✅ |
|
||||
| [Extensible Plugin System](/extending-nx/intro/getting-started) | ❌ | ✅ |
|
||||
|
||||
@ -7,7 +7,7 @@ In this recipe, we'll show you how to create a [Remix](https://remix.run) applic
|
||||
```{% command="npx create-nx-workspace acme --preset=apps" path="~/" %}
|
||||
> NX Let's create a new workspace [https://nx.dev/getting-started/intro]
|
||||
|
||||
✔ Enable distributed caching to make your CI faster · Yes
|
||||
✔ Enable remote caching to make your CI faster · Yes
|
||||
|
||||
> NX Creating your v16.3.2 workspace.
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ Note that the relationship between Nx and Turborepo isn’t the same as with Nx
|
||||
|
||||
We do our best to be unbiased, but, of course you should do your own research. Read the docs, try things out and build your own opinion.
|
||||
|
||||
We clearly separate Nx (the open source tool) and [Nx Cloud](https://nx.app) (the SAAS product). Turborepo doesn’t have such a separation. Hence, in this guide we compare Turborepo with Nx+Nx Cloud (so it’s apples to apples). That said, you don’t have to use Nx Cloud to get features such as distributed caching and distributed task execution. We provide public APIs so you can build your own, if you'd prefer not to use Nx Cloud.
|
||||
We clearly separate Nx (the open source tool) and [Nx Cloud](https://nx.app) (the SAAS product). Turborepo doesn’t have such a separation. Hence, in this guide we compare Turborepo with Nx+Nx Cloud (so it’s apples to apples). That said, you don’t have to use Nx Cloud to get features such as remote caching and distributed task execution. We provide public APIs so you can build your own, if you'd prefer not to use Nx Cloud.
|
||||
|
||||
We are going to compare the tools in three different ways: **features**, **tech and performance**, and **community**.
|
||||
|
||||
@ -65,13 +65,13 @@ Local computation caching (often also refered to as "build caching") is the proc
|
||||
- Turborepo only uses piping to capture the terminal output. Piping doesn’t work well for the tasks emitting “interesting” output (cypress, webpack, etc). As a result, **the terminal output with Turborepo and without it doesn’t look the same**. Nx can use piping, but it also supports other strategies. As a result, Nx is able to capture the output “as is”. **Running say Cypress with Nx or without Nx results in the same output**, and the replayed output matches the original output exactly as well.
|
||||
- Once again, Nx is pluggable, so you can write plugins which determine what can affect a given computation, and some Nx plugins do that.
|
||||
|
||||
#### 7. Distributed computation caching
|
||||
#### 7. Remote computation caching
|
||||
|
||||
Local computation caching helps speed up things locally, but the real benefits start when you distribute and share that cache remotely with your CI system and teammates.
|
||||
|
||||
- Both Nx and Turborepo support it.
|
||||
- Nx exposes a public API, which allows you to provide your own implementation of the remote cache (and some companies do). Turborepo’s implementation is not customizable, so you have to use Turborepo’s distributed cache.
|
||||
- If you choose not to implement your own version of the distributed cache, you can use Nx Cloud. **There is an on-prem version of Nx Cloud, so you can host your own cached artifacts. Turborepo doesn’t offer an on-prem solution.**
|
||||
- Nx exposes a public API, which allows you to provide your own implementation of the remote cache (and some companies do). Turborepo’s implementation is not customizable, so you have to use Turborepo’s remote cache.
|
||||
- If you choose not to implement your own version of the remote cache, you can use Nx Cloud. **There is an on-prem version of Nx Cloud, so you can host your own cached artifacts. Turborepo doesn’t offer an on-prem solution.**
|
||||
|
||||
#### 8. Distributed task execution
|
||||
|
||||
@ -81,7 +81,7 @@ A crucial feature in Nx is the ability to not only parallelize your tasks on a s
|
||||
- **Turborepo doesn’t support it.** The best thing you can do when using Turborepo is binning/sharding, and that doesn’t work for non-trivial workspaces.
|
||||
- **Distributed task execution has a significantly higher impact on the ability to scale the repo than the computation cache.** You can scale without the cache, you cannot scale without the distribution.
|
||||
- This is the biggest feature related to performance and scaling that Turborepo is missing. And it’s by far the hardest one to build.
|
||||
- As with the rest of Nx, you can build your own version of the distributed task execution given the provided public API. If you choose not to implement your own version of the distributed cache, you can use Nx Cloud. There is an [on-prem version of Nx Cloud](https://nx.app/private-cloud), so you have full control over where the artifacts are stored.
|
||||
- As with the rest of Nx, you can build your own version of the distributed task execution given the provided public API. If you choose not to implement your own version of the remote cache, you can use Nx Cloud. There is an [on-prem version of Nx Cloud](https://nx.app/private-cloud), so you have full control over where the artifacts are stored.
|
||||
|
||||
If you want to learn more, check out our article on [Distributing CI - Binning and Distributed Task Execution](https://blog.nrwl.io/distributing-ci-binning-and-distributed-task-execution-632fe31a8953)
|
||||
|
||||
|
||||
@ -40,7 +40,7 @@ Nx provides tools to give you the benefits of a monorepo without the drawbacks o
|
||||
|
||||
- **Affected Commands** - [Nx’s affected commands](/nx-api/nx/documents/affected) analyze your source code, the context of the changes, and only runs tasks on the affected projects impacted by the source code changes.
|
||||
|
||||
- **Distributed Caching** - Nx provides local caching and support for distributed caching of command executions. With distributed caching, when someone on your team runs a command, everyone else gets access to those artifacts to speed up their command executions, bringing them down from minutes to seconds. Nx helps you scale your development to massive applications and libraries even more with distributed task execution and incremental builds.
|
||||
- **Remote Caching** - Nx provides local caching and support for remote caching of command executions. With remote caching, when someone on your team runs a command, everyone else gets access to those artifacts to speed up their command executions, bringing them down from minutes to seconds. Nx helps you scale your development to massive applications and libraries even more with distributed task execution and incremental builds.
|
||||
|
||||
### Scaling your organization with Nx
|
||||
|
||||
|
||||
@ -102,7 +102,7 @@ Nx works even without `nx.json` but to configure some more details such as the `
|
||||
Having done these steps, you can now keep using your Lerna repository as you did before. All the commands will work in a backwards compatible way but will be a lot faster. [Read our blog post for some benchmarks](https://blog.nrwl.io/lerna-used-to-walk-now-it-can-fly-eab7a0fe7700?source=friends_link&sk=6c827ec7c9adfc1c760ff2e3f3e05cc7).
|
||||
|
||||
{% callout type="note" title="Enable remote caching?" %}
|
||||
This does not include distributed caching or distributed task execution powered by Nx Cloud. But you can easily add support for it if wanted. All that's required is `npx nx connect-to-nx-cloud`.
|
||||
This does not include remote caching or distributed task execution powered by Nx Cloud. But you can easily add support for it if wanted. All that's required is `npx nx connect-to-nx-cloud`.
|
||||
{% /callout %}
|
||||
|
||||
### Switch to the Nx native commands in your Lerna workspace
|
||||
|
||||
@ -34,7 +34,7 @@ At the next prompt, you can choose whether to use [Nx Cloud](https://nx.app) or
|
||||
|
||||
```shell
|
||||
? What to create in the new workspace empty [an empty workspace with a layout that works best for building apps]
|
||||
? Set up distributed caching using Nx Cloud (It's free and doesn't require registration.) Yes [Faster builds, run details, GitHub integration. Learn more at https://nx.app]
|
||||
? Set up remote caching using Nx Cloud (It's free and doesn't require registration.) Yes [Faster builds, run details, GitHub integration. Learn more at https://nx.app]
|
||||
```
|
||||
|
||||
## Creating your app
|
||||
|
||||
@ -44,7 +44,7 @@ Run the command `npx create-nx-workspace@latest` and when prompted, provide the
|
||||
✔ What framework should be used? · express
|
||||
✔ Standalone project or integrated monorepo? · standalone
|
||||
✔ Would you like to generate a Dockerfile? [https://docs.docker.com/] · Yes
|
||||
✔ Enable distributed caching to make your CI faster · Yes
|
||||
✔ Enable remote caching to make your CI faster · Yes
|
||||
```
|
||||
|
||||
{% card title="Opting into Nx Cloud" description="You will also be prompted whether to add Nx Cloud to your workspace. We won't address this in this tutorial, but you can see the introduction to Nx Cloud for more details." url="/ci/intro/ci-with-nx" /%}
|
||||
|
||||
@ -44,7 +44,7 @@ Create a new standalone React application with the following command:
|
||||
✔ Which bundler would you like to use? · vite
|
||||
✔ Test runner to use for end to end (E2E) tests · cypress
|
||||
✔ Default stylesheet format · css
|
||||
✔ Enable distributed caching to make your CI faster · Yes
|
||||
✔ Enable remote caching to make your CI faster · Yes
|
||||
```
|
||||
|
||||
You can choose any bundler you like. In this tutorial we're going to use Vite. The above command generates the following structure:
|
||||
|
||||
@ -61,7 +61,7 @@ Create a new React monorepo with the following command:
|
||||
✔ Which bundler would you like to use? · vite
|
||||
✔ Test runner to use for end to end (E2E) tests · cypress
|
||||
✔ Default stylesheet format · css
|
||||
✔ Enable distributed caching to make your CI faster · Yes
|
||||
✔ Enable remote caching to make your CI faster · Yes
|
||||
```
|
||||
|
||||
Let's name the initial application `react-store`. In this tutorial we're going to use `vite` as a bundler, `cypress` for e2e tests and `css` for styling. The above command generates the following structure:
|
||||
|
||||
@ -39,7 +39,7 @@ We can leverage [`nx init`](/recipes/adopting-nx/adding-to-existing-project#inst
|
||||
✔ Which of the following scripts are cacheable? (Produce the same output given the same input, e.g. build, test and lint usually are, serve and start are not). You can use spacebar to select one or more scripts. · build
|
||||
|
||||
✔ Does the "build" script create any outputs? If not, leave blank, otherwise provide a path (e.g. dist, lib, build, coverage) · dist
|
||||
✔ Enable distributed caching to make your CI faster · No
|
||||
✔ Enable remote caching to make your CI faster · No
|
||||
|
||||
> NX 📦 Installing dependencies
|
||||
|
||||
|
||||
@ -15,7 +15,7 @@ Run the following command with the options listed to create an empty workspace.
|
||||
✔ Where would you like to create your workspace? · myorg
|
||||
✔ Which stack do you want to use? · none
|
||||
✔ Package-based or integrated? · integrated
|
||||
✔ Enable distributed caching to make your CI faster · Yes
|
||||
✔ Enable remote caching to make your CI faster · Yes
|
||||
```
|
||||
|
||||
{% card title="Opting into Nx Cloud" description="You will also be prompted whether to add Nx Cloud to your workspace. We won't address this in this recipe, but you can see the introduction to Nx Cloud for more details." url="/ci/intro/ci-with-nx" /%}
|
||||
|
||||
@ -11,7 +11,7 @@ Problem: A task is being executed when you expect it to be replayed from the cac
|
||||
- To check your input glob patterns file-by-file, you can get a list of all the files associated with each project by running `nx graph --file=output.json` or by clicking on a task in the task graph in the `nx graph` visualization.
|
||||
|
||||
1. Use the Nx Cloud troubleshooting tools
|
||||
- Make sure your repo is [connected to Nx Cloud](/core-features/cache-task-results#distributed-computation-caching)
|
||||
- Make sure your repo is [connected to Nx Cloud](/core-features/cache-task-results#remote-computation-caching)
|
||||
- Click on the run details link that is printed in the terminal after you run a task
|
||||
- Expand a task that had a cache miss
|
||||
- Click "Check For Near Misses" to see other similar tasks
|
||||
|
||||
@ -37,4 +37,4 @@ Nx will set the following environment variables so they can be accessible within
|
||||
| NX_DRY_RUN | boolean | Set to `true` during dry runs of generators. Use this to avoid side effects during generators. |
|
||||
| NX_INTERACTIVE | boolean | Set to `false` when running generators with `--interactive=false`. Use this to prevent prompting during generators |
|
||||
|
||||
When using distributed caching, [Nx Cloud Environment Variables](/ci/reference/env-vars) are also available.
|
||||
When using remote caching, [Nx Cloud Environment Variables](/ci/reference/env-vars) are also available.
|
||||
|
||||
@ -58,7 +58,7 @@ A set of preconfigured options for a [target](#target) that should be enabled al
|
||||
|
||||
> See: [Use Executor Configurations](/core-features/plugin-features/use-task-executors#use-executor-configurations)
|
||||
|
||||
### Distributed Cache
|
||||
### Remote Cache
|
||||
|
||||
A [cache](#cache) that can be shared between all developers using the repo and the CI system.
|
||||
|
||||
@ -118,7 +118,7 @@ A [project](#project) that is located in a sub-folder of another project. This w
|
||||
|
||||
### Nx Cloud
|
||||
|
||||
A service that provides [distributed caching](#distributed-cache) and [distributed task execution](#distributed-task-execution).
|
||||
A service that provides [remote caching](#remote-cache) and [distributed task execution](#distributed-task-execution).
|
||||
|
||||
> See: [CI with Nx](/ci/intro/ci-with-nx)
|
||||
|
||||
|
||||
@ -30,7 +30,7 @@ Create a new Vue application with the following command:
|
||||
|
||||
✔ Test runner to use for end to end (E2E) tests · cypress
|
||||
✔ Default stylesheet format · css
|
||||
✔ Enable distributed caching to make your CI faster · Yes
|
||||
✔ Enable remote caching to make your CI faster · Yes
|
||||
|
||||
> NX Creating your v17.0.0 workspace.
|
||||
|
||||
|
||||
@ -4,13 +4,13 @@ const messageOptions = {
|
||||
nxCloudCreation: [
|
||||
{
|
||||
code: 'set-up-distributed-caching-ci',
|
||||
message: `Enable distributed caching to make your CI faster`,
|
||||
message: `Enable remote caching to make your CI faster`,
|
||||
},
|
||||
],
|
||||
nxCloudMigration: [
|
||||
{
|
||||
code: 'make-ci-faster',
|
||||
message: `Enable distributed caching to make your CI faster?`,
|
||||
message: `Enable remote caching to make your CI faster?`,
|
||||
},
|
||||
],
|
||||
} as const;
|
||||
|
||||
@ -38,10 +38,10 @@ export async function setupNxCloud(
|
||||
|
||||
export function printNxCloudSuccessMessage(nxCloudOut: string) {
|
||||
const bodyLines = nxCloudOut
|
||||
.split('Distributed caching via Nx Cloud has been enabled')[1]
|
||||
.split('Remote caching via Nx Cloud has been enabled')[1]
|
||||
.trim();
|
||||
output.note({
|
||||
title: `Distributed caching via Nx Cloud has been enabled`,
|
||||
title: `Remote caching via Nx Cloud has been enabled`,
|
||||
bodyLines: bodyLines.split('\n').map((r) => r.trim()),
|
||||
});
|
||||
}
|
||||
|
||||
@ -73,7 +73,7 @@ export async function connectToNxCloudPrompt(prompt?: string) {
|
||||
.prompt([
|
||||
{
|
||||
name: 'NxCloud',
|
||||
message: prompt ?? `Enable distributed caching to make your CI faster`,
|
||||
message: prompt ?? `Enable remote caching to make your CI faster`,
|
||||
type: 'autocomplete',
|
||||
choices: [
|
||||
{
|
||||
|
||||
@ -4,7 +4,7 @@ import { parseCSV } from '../yargs-utils/shared-options';
|
||||
export const yargsInitCommand: CommandModule = {
|
||||
command: 'init',
|
||||
describe:
|
||||
'Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up distributed caching. For more info, check https://nx.dev/recipes/adopting-nx.',
|
||||
'Adds Nx to any type of workspace. It installs nx, creates an nx.json configuration file and optionally sets up remote caching. For more info, check https://nx.dev/recipes/adopting-nx.',
|
||||
builder: (yargs) => withInitOptions(yargs),
|
||||
handler: async (args: any) => {
|
||||
await (await import('./init')).initHandler(args);
|
||||
@ -16,7 +16,7 @@ function withInitOptions(yargs: Argv) {
|
||||
return yargs
|
||||
.option('nxCloud', {
|
||||
type: 'boolean',
|
||||
description: 'Set up distributed caching with Nx Cloud.',
|
||||
description: 'Set up remote caching with Nx Cloud.',
|
||||
})
|
||||
.option('interactive', {
|
||||
describe: 'When false disables interactive input prompts for options.',
|
||||
|
||||
@ -24,7 +24,7 @@ export async function askAboutNxCloud(): Promise<boolean> {
|
||||
.prompt([
|
||||
{
|
||||
name: 'NxCloud',
|
||||
message: `Enable distributed caching to make your CI faster`,
|
||||
message: `Enable remote caching to make your CI faster`,
|
||||
type: 'autocomplete',
|
||||
choices: [
|
||||
{
|
||||
|
||||
@ -79,7 +79,7 @@ function printSuccessMessage(url: string) {
|
||||
} catch (e) {}
|
||||
|
||||
output.note({
|
||||
title: `Distributed caching via Nx Cloud has been enabled`,
|
||||
title: `Remote caching via Nx Cloud has been enabled`,
|
||||
bodyLines: [
|
||||
`In addition to the caching, Nx Cloud provides config-free distributed execution,`,
|
||||
`UI for viewing complex runs and GitHub integration. Learn more at https://nx.app`,
|
||||
|
||||
@ -5,13 +5,13 @@ export class PromptMessages {
|
||||
nxCloudCreation: [
|
||||
{
|
||||
code: 'set-up-distributed-caching-ci',
|
||||
message: `Enable distributed caching to make your CI faster`,
|
||||
message: `Enable remote caching to make your CI faster`,
|
||||
},
|
||||
],
|
||||
nxCloudMigration: [
|
||||
{
|
||||
code: 'make-ci-faster',
|
||||
message: `Enable distributed caching to make your CI faster?`,
|
||||
message: `Enable remote caching to make your CI faster?`,
|
||||
},
|
||||
],
|
||||
};
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user