From b60dc8ac0df6af9beaf694115e674ad0a25be1fc Mon Sep 17 00:00:00 2001 From: LeSingh1 Date: Fri, 15 May 2026 23:31:00 -0700 Subject: [PATCH] [rush] Document install-run lockfile environment variables Adds documentation for INSTALL_RUN_LOCKFILE_PATH and INSTALL_RUN_RUSH_LOCKFILE_PATH on the Rush environment variables page. Fixes microsoft/rushstack#5359. --- .../docs/pages/configs/environment_vars.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/websites/rushjs.io/docs/pages/configs/environment_vars.md b/websites/rushjs.io/docs/pages/configs/environment_vars.md index 996f2ee27..9a16a830c 100644 --- a/websites/rushjs.io/docs/pages/configs/environment_vars.md +++ b/websites/rushjs.io/docs/pages/configs/environment_vars.md @@ -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