Skip to content

Commit

Permalink
docs(core): env variable pages link to each other (#16258)
Browse files Browse the repository at this point in the history
  • Loading branch information
isaacplmann authored Apr 14, 2023
1 parent 26fbd1d commit 330fe74
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 3 deletions.
8 changes: 6 additions & 2 deletions docs/nx-cloud/reference/env-vars.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Environment Variables

## NX_BRANCH and NX_CI_EXECUTION_ID
### NX_BRANCH and NX_CI_EXECUTION_ID

When running commands on CI, `nx-cloud` needs to know the current branch and the current CI execution ID (something that
uniquely identifies the current CI run or job). **For most CI providers, `nx-cloud` is able to determine both
Expand All @@ -15,7 +15,7 @@ main jobs (e.g., when running CI on both Linux and Windows or when running the s
of Node.js or Java). In this case you can set the `NX_CI_EXECUTION_ENV` env variable on main jobs and agents. The main
job where the `NX_CI_EXECUTION_ENV` is set to, say, `macos`, will connect to the agents with the same env name.

#### NX_RUN_GROUP
### NX_RUN_GROUP

Older versions of `nx-cloud` used `NX_RUN_GROUP` instead of `NX_CI_EXECUTION_ID` and `NX_CI_EXECUTION_ENV`. It
served the same purpose.
Expand Down Expand Up @@ -56,3 +56,7 @@ By default, Nx Cloud requests will time out after 10 seconds. `NX_CLOUD_NO_TIMEO

Setting `NX_VERBOSE_LOGGING` to true will output the debug information about agents communicating with the main job.
This can be useful for debugging unexpected cache misses and issues with on-prem setups.

## See Also

- [Nx Environment Variables](/reference/environment-variables)
2 changes: 2 additions & 0 deletions docs/shared/reference/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,3 +32,5 @@ Nx will set the following environment variables so they can be accessible within
| NX_TASK_TARGET_CONFIGURATION | string | Set to the configuration name of the task being run. Use this to tell which configuration of the target is being run. |
| 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](/nx-cloud/reference/env-vars) are also available.
2 changes: 1 addition & 1 deletion nx-dev/ui-common/src/lib/documentation-header.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ export function DocumentationHeader({
const isNx: boolean = !isNxCloud && !isPackages && !isPlugins && !isRecipes;

const sections = [
{ name: 'Home', href: '/getting-started/intro', current: isNx },
{ name: 'Nx', href: '/getting-started/intro', current: isNx },
{
name: 'Nx Cloud',
href: '/nx-cloud/intro/what-is-nx-cloud',
Expand Down

1 comment on commit 330fe74

@vercel
Copy link

@vercel vercel bot commented on 330fe74 Apr 14, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

nx-dev – ./

nx-dev-git-master-nrwl.vercel.app
nx-five.vercel.app
nx.dev
nx-dev-nrwl.vercel.app

Please sign in to comment.