-
Notifications
You must be signed in to change notification settings - Fork 72
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.
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
[rush] Add a "Compatibility matrix" documenting supported versions of Node/PNPM/etc #232
Draft
octogonz
wants to merge
1
commit into
main
Choose a base branch
from
octogonz/compatibility-matrix
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
41 changes: 41 additions & 0 deletions
41
websites/rushjs.io/docs/pages/maintainer/compatibility_matrix.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
--- | ||
title: Compatibility matrix | ||
--- | ||
|
||
## "Supported" ranges | ||
|
||
| Rush version | Node.js version | PNPM version | Git version | | ||
| ------------ | ------------------------------------------- | ------------------------ | ----------- | | ||
| `5.122.0` | `^16.20.0` <br/> `^18.18.0` <br/> `^20.9.0` | `^7.33.5` <br/> `^8.7.6` | `^2.26.3` | | ||
|
||
## Associated source code constants | ||
|
||
| Variable | Current Value | Source file | Description | | ||
| ------------------------------------ | ------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| `MINIMUM_SUPPORTED_NPM_VERSION` | `'4.5.0'` | [SetupChecks.ts](https://github.com/microsoft/rushstack/blob/main/libraries/rush-lib/src/logic/SetupChecks.ts) | Rush fails if the NPM versions older than this version | | ||
| `MINIMUM_SUPPORTED_PNPM_VERSION` | `'5.0.0'` | [SetupChecks.ts](https://github.com/microsoft/rushstack/blob/main/libraries/rush-lib/src/logic/SetupChecks.ts) | Rush fails if the PNPM versions older than this version | | ||
| `UPCOMING_NODE_LTS_VERSION` | `20` | [NodeJsCompatibility.ts](https://github.com/microsoft/rushstack/blob/main/libraries/rush-lib/src/logic/NodeJsCompatibility.ts) | This constant is the major version of the next LTS node Node.js release. | | ||
| `reportAncientIncompatibleVersion()` | `'<14.18.0'` | [NodeJsCompatibility.ts](https://github.com/microsoft/rushstack/blob/main/libraries/rush-lib/src/logic/NodeJsCompatibility.ts) | Used to report when the Node.js version is known to have serious incompatibilities. In that situation, the user should downgrade Rush to an older release that supported their Node.js version. | | ||
|
||
## Node.js CI validation | ||
|
||
Rush Stack's continuous integration currently builds: | ||
|
||
[rushstack/.github/workflows/ci.yml](https://github.com/microsoft/rushstack/blob/main/.github/workflows/ci.yml) | ||
|
||
```yaml | ||
matrix: | ||
include: | ||
- NodeVersion: 16.20.x | ||
NodeVersionDisplayName: 16 | ||
OS: ubuntu-latest | ||
- NodeVersion: 18.18.x | ||
NodeVersionDisplayName: 18 | ||
OS: ubuntu-latest | ||
- NodeVersion: 20.9.x | ||
NodeVersionDisplayName: 20 | ||
OS: ubuntu-latest | ||
- NodeVersion: 18.18.x | ||
NodeVersionDisplayName: 18 | ||
OS: windows-latest | ||
``` |
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mention Jest incompatibility with Node.js 18.20+ and 19+