[rush] Add support for RUSH_OVERRIDE_PATH environment variable #5003
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…h through RUSH_OVERRIDE_PATH
witcher112
requested review from
iclanton,
octogonz,
apostolisms,
D4N14L and
dmichon-msft
as code owners
iclanton
reviewed
Nov 18, 2024
| } | ||
| } | ||
|
|
||
| if (semver.lt(version, '3.0.20')) { | ||
| // In old versions, requiring the entry point invoked the command-line parser immediately, | ||
| // so fail if "rushx" or "rush-pnpm" was used | ||
| RushCommandSelector.failIfNotInvokedAsRush(version); | ||
| require(path.join(expectedRushPath, 'node_modules', '@microsoft', 'rush', 'lib', 'rush')); | ||
| require(path.join(rushPath, 'lib', 'rush')); | ||
| } else if (semver.lt(version, '4.0.0')) { |
There was a problem hiding this comment.
This condition is checked twice now.
There was a problem hiding this comment.
Actually looks like it's checked in a few places.
| "changes": [ | ||
| { | ||
| "packageName": "@microsoft/rush", | ||
| "comment": "Add support for overriding rush with custom installation path through RUSH_OVERRIDE_PATH environment variable", |
There was a problem hiding this comment.
Suggested change
| "comment": "Add support for overriding rush with custom installation path through RUSH_OVERRIDE_PATH environment variable", | |
| "comment": "Add support for overriding Rush with a custom installation path through a new `RUSH_OVERRIDE_PATH` environment variable. This environment variable is intended to be used for development of Rush itself.", |
| installIsValid = await installMarker.isValidAsync(); | ||
| if (installIsValid) { | ||
| console.log('Another process performed the installation.'); | ||
| if (semver.lt(version, '4.0.0')) { |
There was a problem hiding this comment.
Suggested change
| if (semver.lt(version, '4.0.0')) { | |
| if (isLegacyRushVersion) { |
|
|
||
| const overrideVersion: string = overridePackageJson.version; | ||
|
|
||
| // If we are overriding with an older Rush that doesn't understand the RUSH_OVERRIDE_PATH variable, |
There was a problem hiding this comment.
Suggested change
| // If we are overriding with an older Rush that doesn't understand the RUSH_OVERRIDE_PATH variable, | |
| // If we are overriding with an older version of Rush that doesn't understand the RUSH_OVERRIDE_PATH variable, |
| const overridePackageJson: IPackageJson | undefined = PackageJsonLookup.instance.tryLoadPackageJsonFor(overridePath); | ||
|
|
||
| if (overridePackageJson === undefined) { | ||
| terminal.writeErrorLine(`Cannot use version specified with "RUSH_OVERRIDE_PATH" environment variable as it doesn't point to valid Rush package: ${overridePath}`); |
There was a problem hiding this comment.
Suggested change
| terminal.writeErrorLine(`Cannot use version specified with "RUSH_OVERRIDE_PATH" environment variable as it doesn't point to valid Rush package: ${overridePath}`); | |
| terminal.writeErrorLine(`Unable to load the a copy of `rush-lib` specified with ` + | |
| `the "${EnvironmentVariableNames.RUSH_OVERRIDE_PATH}" environment ` + | |
| `variable: ${overridePath}`); |
| // If we are overriding with an older Rush that doesn't understand the RUSH_OVERRIDE_PATH variable, | ||
| // then unset it. | ||
| if (semver.lt(overrideVersion, '5.141.0')) { | ||
| delete process.env[EnvironmentVariableNames.RUSH_OVERRIDE_PATH]; |
There was a problem hiding this comment.
Should we just always delete the env var here?
|
|
||
| PrintUtilities.printMessageInBox( | ||
| [ | ||
| `WARNING! THE "RUSH_OVERRIDE_PATH" ENVIRONMENT VARIABLE IS SET.`, |
There was a problem hiding this comment.
Suggested change
| `WARNING! THE "RUSH_OVERRIDE_PATH" ENVIRONMENT VARIABLE IS SET.`, | |
| `WARNING! THE "${EnvironmentVariableNames.RUSH_OVERRIDE_PATH}" ENVIRONMENT VARIABLE IS SET.`, |
| ...( | ||
| configuration | ||
| ? [ | ||
| `The rush.json configuration asks for: @${configuration.rushVersion}`, |
There was a problem hiding this comment.
Suggested change
| `The rush.json configuration asks for: @${configuration.rushVersion}`, | |
| `The ${RushConstants.rushJsonFilename} configuration asks for v${configuration.rushVersion}`, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
While contributing to Rush, I've discovered that there's no easy way to test it with my company's repo as we heavily use VSCode tasks.json that hardcode "rush" command for many operations (so using method described in https://rushjs.io/pages/contributing/#testing-rush-builds is not possible as it would involve replacing all "rush" occurrences with "testrush").
Details
This PR introduces support for the
RUSH_OVERRIDE_PATHenvironment variable, which can specify the path to the custom Rush installation. This way, contributors can override the Rush installation used by the repository and test any changes that are being made to Rush, even if therushcommand is hardcoded somewhere.If
RUSH_OVERRIDE_PATHis present, the user is presented with a warning similar to the one displayed when using theRUSH_PREVIEW_VERSIONenvironment variable.How it was tested
I've set
RUSH_OVERRIDE_PATHthat points to custom Rush installation and executednode apps\rush\bin\rush build --help- seems to be working.Impacted documentation
https://rushjs.io/pages/contributing