Skip to content
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
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions websites/rushjs.io/docs/pages/maintainer/compatibility_matrix.md
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
Copy link
Collaborator Author

@octogonz octogonz Jul 12, 2024

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+


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
```
3 changes: 2 additions & 1 deletion websites/rushjs.io/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ const sidebars = {
'pages/maintainer/phased_builds',
'pages/maintainer/cobuilds',
'pages/maintainer/npm_registry_auth',
'pages/maintainer/custom_tips'
'pages/maintainer/custom_tips',
'pages/maintainer/compatibility_matrix'
]
},
{
Expand Down