update documentation to display required minimum version of glibc and retroactively supported operating systems #5877
Conversation
… retroactively supported operating systems
AtofStryker
force-pushed
the
update_linux_docs
branch
from
595124a to
a1d901c
Compare
AtofStryker
requested review from
cacieprins,
jennifer-shehane and
ryanthemanuel
There was a problem hiding this comment.
My understanding is that Node.js requires a minimum of glibc 2.28, so this addition to the documentation would be conflicting with the requirement to use a supported version of Node.js. The currently listed Linux operating systems meet this requirement.
There are some links and discussions in #5444 (comment) and #5444 (comment) about this subject.
See also detailed list on https://github.com/nodejs/node/blob/v18.x/BUILDING.md#platform-list
|
@MikeMcC399 Technically the language we used on Cypress v13 was that Node.js 16 was deprecated:
We're a bit in a spot where if we want to remove support for glibc 2.17, this will break users, so we're anticipating needing to do this in a future release and encourage users to upgrade now. |
|
I understand where you are coming from now. I can try and reword the text into a deprecation notice if you want. |
|
@MikeMcC399 Yah, if you think some other wording makes sense, that'd be great. |
|
Building on the previous deprecation notice, I'm wondering if this wouldn't also be better placed in the next release notes. If it needs to go into the documentation, then my suggestion would be the following. It avoids mentioning the unsupported operating systems by name (they were previously not listed anyway) and puts the onus on users to check their glibc version using the Linux command Node.js Cypress deprecated the use of Node.js |
|
@jennifer-shehane @MikeMcC399 I applied the suggestions in e69d00a. @jennifer-shehane with the next release do we want to make notice about the glibc deprecations? |
| - **Windows** 10 and above _(64-bit only)_ | ||
| below). | ||
| - Cypress deprecated the use of Node.js `16.x` in Cypress [`13.0.0`](/guides/references/changelog#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`](https://www.gnu.org/software/libc/) versions `2.17` - `2.27`. The Linux CLI command `ldd --version` displays your glibc version. |
There was a problem hiding this comment.
Should a note under linux prerequisites be made re: minimum glibc version?
There was a problem hiding this comment.
@cacieprins how is 1e735ed?
| @@ -231,7 +231,7 @@ requirements: | |||
| ### Linux Prerequisites | |||
|
|
|||
| If you're using Linux, you'll want to have the required dependencies installed | |||
| on your system. Depending on your system defaults, these dependencies may already be installed. | |||
| on your system. Cypress on Linux requires a minimum [`glibc`](https://www.gnu.org/software/libc/) version of `2.17`. Depending on your system defaults, these dependencies may already be installed. | |||
There was a problem hiding this comment.
That does not read so well in front of the sentence "Depending on your system defaults, these dependencies may already be installed." as it implies that you can change it, whereas it is a fixed version completely tied to the version of the operating system you are using. It would be better as a separate paragraph or dropped from this section.
The follow-on paragraph also suggests that you can install a different version.
There was a problem hiding this comment.
How is something like 091fe97?
There was a problem hiding this comment.
I'm fine with the replacement paragraph.
|
Selected versions for reference ... Unsupported by Node.js 18.x (glibc < 2.28)
Supported by Node.js 18.x (glibc >= 2.28)
|
at a glance it looks pretty close to what we gathered
|
adds some documentation to our getting started page that shows our minimum glibc version, as well as retroactively supported linux distributions that should work with the cypress binary