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

Remove Linux OS and Node.js deprecation notes #6090

Merged

Conversation

MikeMcC399
Copy link
Contributor

@MikeMcC399 MikeMcC399 commented Jan 26, 2025

Issue

The Linux section of App > Get Started > Install Cypress > System requirements > Operating System contains the following deprecation notices:

  • Cypress deprecated the use of Node.js 16.x in Cypress 13.0.0. We recommend that users update to at least Node.js 18.x.
    For related reasons, Cypress deprecates the use of Linux operating systems with library glibc versions 2.17 - 2.27. The Linux CLI command ldd --version displays your glibc version.

With the release of Cypress 14.0.0 the deprecation notes are no longer necessary in this location as the information is now covered in the release notes. Leaving them here is likely to be confusing for readers, since Node.js 16.x is not simply deprecated, it is now no longer supported.

Cypress documentation is not versioned and, apart from history lists, it only documents the latest major version of Cypress.

Node.js min 18.x

  1. App > Get Started > Install Cypress > System requirements > Node.js lists a minimum of Node.js 18.x
  2. Release notes Cypress 14.0.0 > Breaking Changes lists

    Removed support for Node.js 16 and Node.js 21. Addresses #29930.

glib min 2.17

  1. App > Get Started > Install Cypress > System requirements > Linux Prerequisites lists a minimum glibc >= 22.17.
  2. This is not consistent with a minimum of Node.js 18.x. Node.js 18 requires a minimum of GLIBC 2.28 on x64 Linux systems (see https://github.com/nodejs/node/blob/v18.0.0/BUILDING.md#unix-prerequisites). Node.js 18.0.0 and later versions output the error message and will not run:

node: /lib/x86_64-linux-gnu/libc.so.6: version `GLIBC_2.28' not found (required by node)

  1. See also note below where Cypress now requires glibc minimum 2.28

glibc min 2.28

  1. The supported list of Linux operating systems under App > Get Started > Install Cypress > System requirements > Operating System excludes versions which do not meet the minimum version requirement glibc >= 22.28

    Ubuntu 20.04 and above, Fedora 40 and above, and Debian 11 and above

  2. Release notes Cypress 14.0.0 > Breaking Changes lists

    Prebuilt binaries for Linux are no longer compatible with Linux distributions based on glibc <2.28, for example: Ubuntu 14-18, RHEL 7, CentOS 7, Amazon Linux 2. Addresses #29601.

Change

In the Linux section of App > Get Started > Install Cypress > System requirements > Operating System remove the deprecation notices which are now covered in the Cypress 14.0.0 > Breaking Changes release notes.

Remove the periods at the end of each operating system unordered list item to match formatting on the rest of the page for phrases which are not full sentences.

In the App > Get Started > Install Cypress > System requirements > Linux Prerequisites section, remove the outdated reference to glibc minimum of 22.17.

Copy link

netlify bot commented Jan 26, 2025

👷 Deploy request for cypress-docs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit 2779ec5

@cypress-app-bot
Copy link
Collaborator

@MikeMcC399

This comment was marked as outdated.

@MikeMcC399 MikeMcC399 marked this pull request as ready for review January 26, 2025 16:42
Copy link
Member

@jennifer-shehane jennifer-shehane left a comment

Choose a reason for hiding this comment

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

Good catch, should have been an update with 14 docs.

@jennifer-shehane jennifer-shehane merged commit c3dd909 into cypress-io:main Jan 27, 2025
7 checks passed
@MikeMcC399
Copy link
Contributor Author

@jennifer-shehane

Good catch, should have been an update with 14 docs.

I haven't seen anybody confused by this so far, but it was worth cleaning up, especially as I've been working on this page anyway!

@MikeMcC399 MikeMcC399 deleted the remove/os-node-deprecation-notes branch January 27, 2025 20:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants