Skip to content

[rush] Document install-run lockfile environment variables #317

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
LeSingh1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

[rush] Document install-run lockfile environment variables #317

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions websites/rushjs.io/docs/pages/configs/environment_vars.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,25 @@ title: Environment variables

The Rush tool's behavior can be customized using the shell environment variables described below:

## INSTALL_RUN_LOCKFILE_PATH

Specifies the path to a package lockfile (for example, a `package-lock.json`) to use
when the `install-run.js` helper installs the requested package. When this variable
is provided, the helper copies the lockfile into the package install folder and runs
`npm ci` instead of `npm install`.

This is useful in CI environments where installs need to be reproducible and pinned
to a known-good dependency tree.

## INSTALL_RUN_RUSH_LOCKFILE_PATH

Specifies the path to a package lockfile (for example, a `package-lock.json`) to use
when the `install-run-rush.js` helper installs Rush. This variable is similar to
`INSTALL_RUN_LOCKFILE_PATH`, but is scoped specifically to `install-run-rush.js`.

When this variable is provided, `install-run-rush.js` installs Rush using the
specified lockfile and runs `npm ci` instead of `npm install`.

## RUSH_ABSOLUTE_SYMLINKS

If this variable is set to `1`, Rush will create symlinks with absolute paths instead
Expand Down