nx/docs/nx-cloud/intro/connect-to-cloud.md
Jack Hsu 2baf672b61
docs(nx-cloud): update onboarding flow to use "nx connect" (#26842)
The new Nx Cloud onboarding flow is to run `nx connect` and follow the
prompts. There's no need to explain beyond that in the docs since the
flow is prone to changes in nx.app.
2024-07-05 14:19:04 -04:00

1.3 KiB

Connect to Nx Cloud

Nx Cloud directly integrates with your existing CI setup.

Nx Cloud Overview

In a nutshell, here's how this works:

Step 1: Connect your workspace to Nx Cloud

This can be done by signing up on nx.app and then connecting to your git repository.

npx nx connect

Step 2: Your CI script triggers Nx Cloud

- name: Start CI run
  run: 'npx nx-cloud start-ci-run --distribute-on="8 linux-medium-js"'

Let us generate the workflow file for you, if you don't already have one.

npx nx g ci-workflow

Or, check out our recipes for the various CI providers.

Step 3: Run your Nx commands as usual

- run: npx nx-cloud record -- nx format:check
- run: npx nx affected -t lint test build
- run: npx nx affected -t e2e-ci --parallel 1

All these commands are automatically picked up by Nx Cloud, split up into smaller tasks and distributed across the specified number of machines.

Step 4: All results are played back automatically

Nx Cloud automatically plays back all results to your CI system, as if distribution never happened. You can continue doing post-processing on the results, like uploading test reports, deploying artifacts etc.