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

Update Node.js instructions for version managers #6089

Merged
merged 1 commit into from
Jan 27, 2025

Conversation

MikeMcC399
Copy link
Contributor

Issue

App > Get Started > Install Cypress > System requirements > Installing Node.js contains text:

Best Practice

Use a Node.js package manager to install Node.js. Package managers for Node.js allow you to switch between different versions easily.

The link to "Node.js package manager" https://nodejs.org/en/download/package-manager/all is no longer in use by the https://nodejs.org website and so its contents, which is a list of various Node.js version managers, need to be regarded as no longer maintained even if the page is currently still visible. Its local language translations have all been deleted.

Node.js redesigned their Download Node.js landing page and no longer link to the list Installing Node.js via Package Managers.

Instead, Download Node.js suggests using specific Node.js version managers depending on the target operating system (Windows, macOS or Linux).

The current suggestions from Node.js no longer include Node.js Snap for Linux.

Node.js Snap for Linux is not suitable for use with Cypress due to its limited permissions. Several issues arise: Unless node is run as root with sudo, Cypress installation with npm fails. Global installation of pnpm fails. Corepack is not installed by default by the snap package, making it different to Node.js installations by other means. To remedy this and install Corepack manually requires root permissions.

Change

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 602b215

@cypress-app-bot
Copy link
Collaborator

@MikeMcC399 MikeMcC399 marked this pull request as ready for review January 26, 2025 15:32
@MikeMcC399

This comment was marked as outdated.

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.

Much cleaner!

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

@jennifer-shehane

Much cleaner!

I think so too! I will have some other suggestions to submit soon for better documenting package manager usage. I needed this PR merging first though, to give a clean base.

@MikeMcC399 MikeMcC399 deleted the node-version-managers branch January 27, 2025 20:11
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