Skip to content

Commit 12e70a4

Browse files
authored
Merge pull request #317 from LeSingh1/docs-install-run-lockfile-env-vars
[rush] Document install-run lockfile environment variables
2 parents 708e331 + b60dc8a commit 12e70a4

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

websites/rushjs.io/docs/pages/configs/environment_vars.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,25 @@ title: Environment variables
44

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

7+
## INSTALL_RUN_LOCKFILE_PATH
8+
9+
Specifies the path to a package lockfile (for example, a `package-lock.json`) to use
10+
when the `install-run.js` helper installs the requested package. When this variable
11+
is provided, the helper copies the lockfile into the package install folder and runs
12+
`npm ci` instead of `npm install`.
13+
14+
This is useful in CI environments where installs need to be reproducible and pinned
15+
to a known-good dependency tree.
16+
17+
## INSTALL_RUN_RUSH_LOCKFILE_PATH
18+
19+
Specifies the path to a package lockfile (for example, a `package-lock.json`) to use
20+
when the `install-run-rush.js` helper installs Rush. This variable is similar to
21+
`INSTALL_RUN_LOCKFILE_PATH`, but is scoped specifically to `install-run-rush.js`.
22+
23+
When this variable is provided, `install-run-rush.js` installs Rush using the
24+
specified lockfile and runs `npm ci` instead of `npm install`.
25+
726
## RUSH_ABSOLUTE_SYMLINKS
827

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

0 commit comments

Comments
 (0)