Skip to content

Commit

Permalink
docs(nx-cloud): update CTA and connect instructions
Browse files Browse the repository at this point in the history
(cherry picked from commit e74db49)
juristr authored and FrozenPandaz committed Aug 7, 2024

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature.
1 parent 934d5ad commit ac1ac03
Showing 2 changed files with 14 additions and 10 deletions.
19 changes: 10 additions & 9 deletions docs/nx-cloud/intro/connect-to-cloud.md
Original file line number Diff line number Diff line change
@@ -4,41 +4,42 @@ Nx Cloud directly integrates with your existing CI setup.

![Nx Cloud Overview](/shared/images/nx-cloud/nx-cloud-overview.webp)

In a nutshell, here's how this works:
Here's how you get set up.

**Step 1: Connect your workspace to Nx Cloud**
## Step 1: Connect your workspace to Nx Cloud

This can be done by signing up on [nx.app](https://nx.app) and then connecting to your git repository.
To connect your workspace, **push it to GitHub** (or your respective source control provider) and then run:

```shell
npx nx connect
```

**Step 2: Your CI script triggers Nx Cloud**
## Step 2: Configure your CI script

If you have CI set up already, configure [distribution with Nx Agents](/ci/features/distribute-task-execution) as follows:

```yml
- 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.
Alternatively you can generate the CI configuration using:
```shell
npx nx g ci-workflow
```

Or, check out our [recipes for the various CI providers](/ci/recipes/set-up).

**Step 3: Run your Nx commands as usual**
## Step 3: Run your Nx commands as usual

```yml
- run: npx nx-cloud record -- node tools/custom-script.js
- run: npx nx affected -t lint test build
- run: npx nx affected -t e2e-ci --parallel 1
- run: npx nx affected -t lint test build e2e-ci
```
All these commands are automatically picked up by Nx Cloud, split up into smaller tasks and distributed across the specified number of machines. Nx Cloud works with Nx tasks automatically, or you can [record non-Nx commands with `nx-cloud record`](/ci/recipes/other/record-commands).

**Step 4: All results are played back automatically**
## 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.
5 changes: 4 additions & 1 deletion nx-dev/nx-dev/app/nx-cloud/page.tsx
Original file line number Diff line number Diff line change
@@ -61,7 +61,10 @@ export default function NxCloudPage(): JSX.Element {
<Statistics />
</div>
<div className="mt-32 lg:mt-56">
<CallToAction />
<CallToAction
mainActionTitle="Learn more about Nx Cloud on CI"
mainActionLink="/ci/intro/ci-with-nx"
/>
</div>
</DefaultLayout>
);

0 comments on commit ac1ac03

Please sign in to comment.