Skip to content

Commit

Permalink
docs(nx-cloud): update wording of callout
Browse files Browse the repository at this point in the history
  • Loading branch information
lourw committed May 3, 2024
1 parent fda41a3 commit be27c4b
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/nx-cloud/reference/nx-cloud-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@ At the beginning of your main job, invoke `npx nx-cloud start-ci-run`. This tell
command correspond to the same CI run.

{% callout type="warning" title="Do not run start-ci-run locally" %}
`nx-cloud start-ci-run` is designed to run in CI. It will check to see if it is running in a CI environment and if not, it will exit. Bypass this check with `nx-cloud start-ci-run --force`.
It generates a temporary marker file that can cause a local Nx repo to think it's a part of a CI run. This can cause strange behavior like Nx commands timing out or throwing unexpected errors.
`nx-cloud start-ci-run` generates a temporary marker file that can cause a local Nx repo to think it's a part of a CI run. This can cause strange behavior like Nx commands timing out or throwing unexpected errors.
To discourage this from happening, this command will run a check to see if it is running in a CI environment. You can bypass this check with `nx-cloud start-ci-run --force`.

You can remove all generated files with `nx-cloud cleanup` to reset your workspace if you accidentally run this command locally.
If you accidentally run this command locally, remove all generated files with `nx-cloud cleanup` to reset your workspace.
{% /callout %}

You can configure your CI run by passing the following flags:
Expand Down

0 comments on commit be27c4b

Please sign in to comment.