From 3216b8af4ffdc6970bcecb56b96b74da6a1ecd0b Mon Sep 17 00:00:00 2001 From: Mike McCready <66998419+MikeMcC399@users.noreply.github.com> Date: Mon, 2 Dec 2024 16:49:59 +0100 Subject: [PATCH] docs: remove node-gyp contributor workarounds / restrictions --- CONTRIBUTING.md | 25 ++++--------------------- 1 file changed, 4 insertions(+), 21 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e61fffcb1a53..3ee8c7d81040 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -202,36 +202,19 @@ You must have the following installed on your system to contribute locally: - [`Node.js`](https://nodejs.org/en/) (See the root [.node-version](.node-version) file for the required version. You can find a list of tools on [node-version-usage](https://github.com/shadowspawn/node-version-usage) to switch the version of [`Node.js`](https://nodejs.org/en/) based on [.node-version](.node-version).) - [`yarn`](https://yarnpkg.com/en/docs/install) -- [`python`](https://www.python.org/downloads/) (since we use `node-gyp`. See their [repo](https://github.com/nodejs/node-gyp) for Python version requirements. Use Python `3.11` or lower.) +- [`python`](https://www.python.org/downloads/) (since we use `node-gyp`. See their [repo](https://github.com/nodejs/node-gyp) for Python version requirements.) #### Debian/Ubuntu `sudo apt install g++ make` meets the additional requirements to run `node-gyp` in the context of building Cypress from source. `python` is pre-installed on Debian-based systems including Ubuntu. -The Python versions shipped with Ubuntu versions `20.04` and `22.04` are compatible with Cypress requirements. +The Python versions shipped with Ubuntu versions `20.04`, `22.04` and `24.*` are compatible with Cypress requirements. -Only on Ubuntu `24.04` install Python `3.11` by executing the following commands: - -```shell -sudo add-apt-repository ppa:deadsnakes/ppa -sudo apt update -sudo apt install python3.11 -``` - -Add the environment variable `NODE_GYP_FORCE_PYTHON` to `~/.bashrc`: - -```shell -export NODE_GYP_FORCE_PYTHON=/usr/bin/python3.11 -``` - -> [!IMPORTANT] -> The above steps to install an earlier version of Python are currently not available for the interim release Ubuntu `24.10`. The highest compatible Ubuntu version for rebuilding Cypress from source error-free is currently Ubuntu `24.04`. - -For Ubuntu `24.04` refer also to the [Release notes](https://discourse.ubuntu.com/t/noble-numbat-release-notes/39890) in the section [Unprivileged user namespace restrictions](https://discourse.ubuntu.com/t/noble-numbat-release-notes/39890#unprivileged-user-namespace-restrictions-15) and apply one of the workarounds to disable unprivileged user namespace restrictions for the entire system, either for one boot or persistently, as described. If you do not do this you may receive an error which includes the text `FATAL:setuid_sandbox_host.cc` when you try to run Cypress on this version of Ubuntu after building Cypress from source. +For Ubuntu `24.04` and above, refer also to the [Ubuntu 24.04 Release notes](https://discourse.ubuntu.com/t/noble-numbat-release-notes/39890) in the section "Unprivileged user namespace restrictions" and apply one of the workarounds to disable unprivileged user namespace restrictions for the entire system, either for one boot or persistently, as described. If you do not do this you may receive an error which includes the text `FATAL:setuid_sandbox_host.cc` when you try to run Cypress on these versions of Ubuntu after building Cypress from source. #### Windows -When installing the Visual Studio C++ environment recommended by [node-gyp](https://github.com/nodejs/node-gyp), install also a Windows 10 SDK. The currently used version of `node-gyp` may otherwise fail to recognise the Visual Studio installation. +Currently no additional instructions for installation requirements. ### Getting Started