Rush Stack商店部落格活動
跳至主要內容

環境變數

Rush 工具的行為可以使用下面描述的 shell 環境變數進行自訂

如果將此變數設定為 1，Rush 將會建立使用絕對路徑而非相對路徑的符號連結。當儲存庫在建置期間被移動或儲存庫的部分內容被移動到沙箱中時，這可能是必要的。

RUSH_ALLOW_UNSUPPORTED_NODEJS​

如果將此變數設定為 1，當執行的 Node 版本不符合 rush.json 中 nodeSupportedVersionRange 欄位指定的條件時，Rush 將不會使建置失敗。

RUSH_ALLOW_WARNINGS_IN_SUCCESSFUL_BUILD​

設定此環境變數會覆寫 command-line.json 設定檔中 allowWarningsInSuccessfulBuild 的值。指定 1 以允許在成功的建置中出現警告，或指定 0 以不允許它們。(請參閱 command-line.json 檔案中的註解以取得更多資訊)。

RUSH_BUILD_CACHE_CREDENTIAL (實驗性)​

此環境變數由實驗性的 建置快取 功能使用。

提供用於存取遠端建置快取的憑證 (如果已設定)。此憑證會覆寫任何快取的憑證。

設定此環境變數會覆寫使用 rush update-cloud-credentials 儲存在本機雲端快取憑證中的任何憑證。

如果 Azure Blob 儲存體用於儲存快取項目，則這必須是以查詢參數序列化的 SAS 權杖。請參閱這篇文章以取得有關 SAS 權杖的詳細資訊。

RUSH_BUILD_CACHE_ENABLED (實驗性)​

此環境變數由實驗性的 建置快取 功能使用。

設定此環境變數會覆寫 build-cache.json 設定檔中 buildCacheEnabled 的值。指定 1 以啟用建置快取，或指定 0 以停用它。

如果設定為 0，則相當於傳遞 --disable-build-cache 旗標。

如果未設定建置快取，則會忽略此環境變數。

RUSH_BUILD_CACHE_WRITE_ALLOWED (實驗性)​

此環境變數由實驗性的 建置快取 功能使用。

覆寫 build-cache.json 設定檔中 isCacheWriteAllowed 的值。此環境變數的值必須是 1 (代表 true) 或 0 (代表 false)。如果未設定建置快取，則會忽略此環境變數。

RUSH_COBUILD_CONTEXT_ID (實驗性)​

共同建置管線必須定義此環境變數；如果沒有此變數，Rush 將執行一般建置而沒有任何共同建置邏輯。請參閱 共同建置 文件以取得詳細資訊。

RUSH_COBUILD_LEAF_PROJECT_LOG_ONLY_ALLOWED (實驗性)​

當您使用共同建置功能，但 Rush 建置快取無法用於相依性圖中的「葉」專案時，這會很有用。(例如，已啟用常用程式庫的建置快取，但取用這些程式庫的應用程式則否。) 通常，因為我們無法從快取取得這類專案，所以所有共同建置機器都會被迫建置該專案。如果我們的目標是驗證專案是否成功建置，而不是部署它，這會很沒有效率。

將 RUSH_COBUILD_LEAF_PROJECT_LOG_ONLY_ALLOWED 設定為 1 會導致 Rush 對已停用建置快取的葉專案使用特殊的「僅記錄檔」快取。記錄檔會被快取，並會顯示在其他共同建置機器上，但專案內容會被快取或還原。請參閱 共同建置 文件以取得詳細資訊。

RUSH_COBUILD_RUNNER_ID (實驗性)​

此環境變數可唯一識別每部共同建置機器。如果未定義此變數，Rush 將在每次執行時產生隨機識別碼。請參閱 共同建置 文件以取得詳細資訊。

RUSH_DEPLOY_TARGET_FOLDER​

此環境變數可用於為 rush deploy 指令指定 --target-folder 參數。

RUSH_GIT_BINARY_PATH​

明確指定某些 Rush 作業所叫用的 Git 二進位檔路徑。

RUSH_TAR_BINARY_PATH​

明確指定某些 Rush 作業所叫用的 tar 二進位檔路徑。

RUSH_GLOBAL_FOLDER​

覆寫 Rush 儲存暫存檔案的 ~/.rush 全域資料夾的位置。

Rush 建立的大多數暫存檔案都分別儲存在每個單一儲存庫工作資料夾中，以避免工具版本之間的並行和相容性問題。但是，一小組檔案 (例如 @microsoft/rush-lib 引擎和套件管理員的安裝) 會儲存在全域資料夾中，以加快安裝速度。預設位置在類 POSIX 作業系統上是 ~/.rush，在 Windows 上是 C:\Users\您的名稱。

使用 RUSH_GLOBAL_FOLDER 指定不同的資料夾路徑。例如，如果 Windows 群組原則禁止執行安裝在使用者首頁目錄中的指令碼，這會很有用。

(POSIX 是電機電子工程師學會 (Institute of Electrical and Electronic Engineers, Inc.) 的註冊商標。)

RUSH_INVOKED_FOLDER​

當 Rush 執行 shell 指令碼時，它有時會將工作目錄變更為專案資料夾或儲存庫根資料夾。原始工作目錄 (叫用 Rush 指令的位置) 會指派給子處理序的 RUSH_INVOKED_FOLDER 環境變數，以防指令碼需要它。

RUSH_INVOKED_FOLDER 變數與套件管理員在執行生命週期指令碼時指派的 INIT_CWD 變數概念相同。

RUSH_PARALLELISM​

指定在建置期間啟動的並行處理序數上限。如需更多資訊，請參閱 rush build 的 --parallelism 參數的命令列說明。

RUSH_PNPM_STORE_PATH​

當使用 PNPM 作為套件管理員時，此變數可用於設定 PNPM 將用作儲存目錄的路徑。

如果使用相對路徑，則儲存路徑將會相對於處理序的目前工作目錄來解析。建議使用絕對路徑。

RUSH_PREVIEW_VERSION​

此變數會覆寫版本選取器將安裝的 Rush 版本。預設值由 rush.json 中的 rushVersion 欄位決定。

例如，如果您想在升級儲存庫之前試用 Rush 的不同版本，您可以這樣指派變數

# This is Bash's syntax; for Windows shell, change "export" to be "set"
export RUSH_PREVIEW_VERSION=5.0.0-dev.25

rush install

RUSH_TEMP_FOLDER​

這個變數會覆寫 Rush 使用的暫存資料夾。預設值是儲存庫根目錄下的 common/temp。

這個環境變數與工作區安裝 (useWorkspaces = true) 不相容。如果嘗試移動 PNPM 儲存路徑，請參閱 RUSH_PNPM_STORE_PATH 環境變數。

RUSH_VARIANT​

這個變數會選擇 Rush 在安裝和連結套件依賴時使用的特定安裝變體。

有關此功能的更多資訊，請參閱 安裝變體。