Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 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
52 changes: 52 additions & 0 deletions docs/app/get-started/install-cypress.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -108,10 +108,62 @@ Cypress supports running under these operating systems:
- Ubuntu 20.04 and above
- Debian 11 and above
- Fedora 41 and above
- RHEL and CentOS 9 and above
- **Windows** 10 and 11 _(x64)_
- **Windows** 11 24H2 _(arm64, runs in [x64 emulation](https://learn.microsoft.com/en-us/windows/arm/apps-on-arm-x86-emulation) mode, minimum Cypress [14.5.0](/app/references/changelog#14-5-0) required)_ - preview status
- **Windows Server** 2019, 2022 and 2025 _(x64)_

#### Operating System Support Matrix

The following matrix shows which major operating system versions support Cypress:

| Distribution | Version | Cypress 14 | Cypress 15 |
| ------------------ | ---------------- | ---------- | ---------- |
| **macOS** | 10.15 (Catalina) | ❌ | ❌ |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest removing the Cypress 14 column. The docs are meant to reflect 'current version' always aside from the Changelog and Migration Guide docs

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is is possible to add this and then add a commit that removes it and we rebase merge the commits into the main branch so we at least have the historical record some place?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't add this table! It makes it horribly complicated and difficult to maintain.

You're not really testing against all these operating systems and versions and listing them all is creating a whole lot of unnecessary support exposure.

99% of users are on Ubuntu / Debian / Fedora / Windows / macOS as can be seen from issues reported

| | 11.0+ (Big Sur+) | ✅ | ✅ |
| **Windows** | 7 | ❌ | ❌ |
| | 8/8.1 | ❌ | ❌ |
| | 10 | ✅ | ✅ |
| | 11 | ✅ | ✅ |
| | 11 24H2 (arm64) | ⚠️ | ⚠️ |
| **Windows Server** | 2016 | ❌ | ❌ |
| | 2019 | ✅ | ✅ |
| | 2022 | ✅ | ✅ |
| | 2025 | ✅ | ✅ |
| **Ubuntu** | 18.04 LTS | ❌ | ❌ |
| | 20.04 LTS | ✅ | ✅ |
| | 22.04 LTS | ✅ | ✅ |
| | 24.04 LTS | ✅ | ✅ |
| **Debian** | 10 (Buster) | ✅ | ❌ |
| | 11 (Bullseye) | ✅ | ✅ |
| | 12 (Bookworm) | ✅ | ✅ |
| **RHEL/CentOS** | 7 | ❌ | ❌ |
| | 8 | ✅ | ❌ |
| | 9 | ✅ | ✅ |
| **AlmaLinux** | 8 | ✅ | ❌ |
| | 9 | ✅ | ✅ |
| **Rocky Linux** | 8 | ✅ | ❌ |
| | 9 | ✅ | ✅ |
| **Fedora** | 31 | ❌ | ❌ |
| | 32+ | ✅ | ✅ |
| **openSUSE** | Leap 15.2 | ✅ | ✅ |
| | Leap 15.3+ | ✅ | ✅ |
| | Tumbleweed | ✅ | ✅ |
| **Arch Linux** | Rolling | ✅ | ✅ |
| **Amazon Linux** | 2 | ❌ | ❌ |
| | 2023 | ✅ | ✅ |

**Legend:**

- ✅ **Supported**: Meets all requirements
- ❌ **Not Supported**: Does not meet one or more requirements
- ⚠️ **Preview**: Experimental support, may have limitations

**Requirements:**

- **Cypress 14**: Node.js 18+, glibc 2.28+ (Linux), macOS 11.0+, Windows 10+
- **Cypress 15**: Node.js 20+, glibc 2.31+ (Linux), macOS 11.0+, Windows 10+

### Node.js

Cypress requires [Node.js](https://nodejs.org/) in order to install. We support the versions listed below:
Expand Down
49 changes: 49 additions & 0 deletions docs/app/references/migration-guide.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,55 @@ Cypress requires [Node.js](https://nodejs.org/en) in order to install the Cypres
Node.js versions 18 and 23 are no longer supported.
[See Node's release schedule](https://github.com/nodejs/Release).

### Unsupported Linux Distributions

Prebuilt binaries for Linux are no longer compatible with Linux distributions based on glibc `<2.31`.
This support is in line with Node.js's support for Linux in 20+.

If you're using a Linux distribution based on glibc `<2.31`, for example, Ubuntu 18.04, RHEL 8, CentOS 8, AlmaLinux 8, Rocky Linux 8, you'll need to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Although it is true that Ubuntu 18 won't work with Cypress 15, it was already removed in 2023 - see #5515 because it didn't meet the previous criteria for minimum glibc 2.28. So it could probably be removed from the list here. That is to say it is not compatible with Cypress 14 either, so it's nothing new for Cypress 15.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just for background information - attempting to install Cypress 14 on Ubuntu 18.04 definitely doesn't work:

$ n 16
     copying : node/16.20.2
   installed : v16.20.2 (with npm 8.19.4)
$ yarn add cypress
yarn add v1.22.22
info No lockfile found.
[1/4] Resolving packages...
[2/4] Fetching packages...
error [email protected]: The engine "node" is incompatible with this module. Expected version "^18.0.0 || ^20.0.0 || >=22.0.0". Got "16.20.2"
error Found incompatible module.
info Visit https://yarnpkg.com/en/docs/cli/add for documentation about this command.
$ n 18
  installing : node-v18.20.8
       mkdir : /home/mike/n/n/versions/node/18.20.8
       fetch : https://nodejs.org/dist/v18.20.8/node-v18.20.8-linux-x64.tar.xz
     copying : node/18.20.8
node: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.28' not found (required by node)
/home/mike/n/bin/node: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.28' not found (required by /home/mike/n/bin/node)
   installed :  (with npm )

update your system to a newer version to install Cypress 15+.

### Distribution Support Matrix

The following matrix shows which major Linux distributions and macOS versions support the requirements for Cypress 15, compared to Cypress 14:

| Distribution | Version | Cypress 14 | Cypress 15 |
| ---------------- | ---------------- | ---------- | ---------- |
| **Ubuntu** | 18.04 LTS | ❌ | ❌ |
| | 20.04 LTS | ✅ | ✅ |
| | 22.04 LTS | ✅ | ✅ |
| | 24.04 LTS | ✅ | ✅ |
| **Debian** | 10 (Buster) | ✅ | ❌ |
| | 11 (Bullseye) | ✅ | ✅ |
| | 12 (Bookworm) | ✅ | ✅ |
| **RHEL/CentOS** | 7 | ❌ | ❌ |
| | 8 | ✅ | ❌ |
| | 9 | ✅ | ✅ |
| **AlmaLinux** | 8 | ✅ | ❌ |
| | 9 | ✅ | ✅ |
| **Rocky Linux** | 8 | ✅ | ❌ |
| | 9 | ✅ | ✅ |
| **Fedora** | 31 | ❌ | ❌ |
| | 32+ | ✅ | ✅ |
| **openSUSE** | Leap 15.2 | ✅ | ✅ |
| | Leap 15.3+ | ✅ | ✅ |
| | Tumbleweed | ✅ | ✅ |
| **Arch Linux** | Rolling | ✅ | ✅ |
| **Amazon Linux** | 2 | ❌ | ❌ |
| | 2023 | ✅ | ✅ |
| **macOS** | 10.15 (Catalina) | ❌ | ❌ |
| | 11.0+ (Big Sur+) | ✅ | ✅ |

**Legend:**

- ✅ **Supported**: Meets all requirements
- ❌ **Not Supported**: Does not meet one or more requirements

**Requirements:**

- **Cypress 14**: Node.js 18+, glibc 2.28+, macOS 11.0+
- **Cypress 15**: Node.js 20+, glibc 2.31+, macOS 11.0+

### Webpack `4` is no longer supported

Cypress is no longer supporting Webpack `4` as it is no longer maintained by the core Webpack team and Webpack `5` has been available since Q4 2020. This includes Webpack `4` support for:
Expand Down