miel.truyen/nx
1
0
Fork 0
Code Issues Pull Requests Actions 5 Packages Projects Releases Wiki Activity

docs(nx-cloud): remove note on --with-env-vars=auto as it is breaking users badly 90% of the time

Browse Source
This commit is contained in:
Juri 2024-12-02 23:14:47 +01:00 committed by Juri Strumpflohner
parent 6b870050b6
commit a54bbcc8ac
2 changed files with 0 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/nx-cloud/reference/launch-templates.md
View File

@ -360,12 +360,6 @@ If you need to send environment variables to agents, you can use the [--with-env
nx-cloud start-ci-run --distribute-on="8 linux-medium-js" --with-env-vars="VAR1,VAR2" nx-cloud start-ci-run --distribute-on="8 linux-medium-js" --with-env-vars="VAR1,VAR2"
``` ```
Or pass all the environment variables except OS-specific ones with this `--with-env-vars="auto"`:
```
nx-cloud start-ci-run --distribute-on="8 linux-medium-js" --with-env-vars="auto"
```
## Pass Values Between Steps ## Pass Values Between Steps
If you need to pass a value from one step to another step, such as assigning the value to an existing or new environment variable. You can write to the `NX_CLOUD_ENV` environment file. If you need to pass a value from one step to another step, such as assigning the value to an existing or new environment variable. You can write to the `NX_CLOUD_ENV` environment file.

7
docs/nx-cloud/reference/nx-cloud-cli.md
View File

@ -206,13 +206,6 @@ main CI jobs and the Nx Agent machines.
If you want to pass other environment variables from the main job to Nx Agents, you can do it as follows: `--with-env-vars="VAR1,VAR2"`. If you want to pass other environment variables from the main job to Nx Agents, you can do it as follows: `--with-env-vars="VAR1,VAR2"`.
This will set `VAR1` and `VAR2` on Nx Agents to the same values set on the main job before any steps run. This will set `VAR1` and `VAR2` on Nx Agents to the same values set on the main job before any steps run.
You can also pass `--with-env-vars="auto"` which will filter out all OS-specific environment variables and pass the rest to Nx Agents.
{% callout type="warning" title="Use Caution With 'auto'" %}
Using `--with-env-vars="auto"` will override any existing environment variables on the Nx Agent, some of which might be critical to the
functionality of that machine. In case of unexpected issues on Nx Agents, try fallback to the explicit variable definition using `--with-env-vars="VAR1,VAR2,..."`.
{% /callout %}
Note: none of the values passed to Nx Agents are stored by Nx Cloud. Note: none of the values passed to Nx Agents are stored by Nx Cloud.
### Enabling/Disabling Distribution ### Enabling/Disabling Distribution