Change .nvmrc and documentation for Node.js version (LTS to 14.18.1) #36744

alexstine · 2021-11-22T17:40:29Z

Description

Instead of using Node.js lts version in .nvmrc and other documentation, this PR switches items to use version 14.18.1. I've found that the lts version can vary from system to system and this has gotten me a couple times. It seems hardcoding the correct version is the appropriate option to fix any confusion going forward.

Why the Change?

This is what happens when running the nvm install command as mentioned in documentation.

`alexstine@asm gutenberg % nvm install --lts

Installing latest LTS version.

v16.13.0 is already installed.

Now using node v16.13.0 (npm v8.1.0)`

I'm not sure exactly why this started happening, but these versions do not work with Gutenberg.

`alexstine@asm gutenberg % node --version

v16.13.0

alexstine@asm gutenberg % npm --version

8.1.0`

While I am not in favor of using older versions, using what works is a must. After asking @tellthemachines on Slack, I decided that a PR with the correct version instead of a generic "lts/*" may be an improvement.

I kind of wonder if this is just some strange issue with my system and this doesn't effect others. In that case, this can be closed out.

How has this been tested?

Whenever I run nvm use, the correct version is loaded up and things just work. 👍

Screenshots

Types of changes

Bug fix.

Checklist:

My code is tested.
My code follows the WordPress code style.
My code follows the accessibility standards.
I've tested my changes with keyboard and screen readers.
My code has proper inline documentation.
I've included developer documentation if appropriate.
I've updated all React Native files affected by any refactorings/renamings in this PR (please manually search all *.native.js files for terms that need renaming or removal).

gziolo · 2021-11-22T18:12:24Z

There is another PR opened nearly 2 weeks ago which pins node to 14.x line rather than to the specific version which is going to change quickly. See #36384 from @walbo. I think the only blocker for using LTS is the fact that Node 16.x that was promoted to LTS a few weeks ago is using npm v8 rather than npm v6 that we still have to use.

I recently noticed that many projects use --legacy-peer-deps with npm 7/8 as a temporary meassure needed until the whole ecosystem is able to handle automatic peer dependencies installation. Maybe we should follow the same path and migrate quicker to Node 16 + npm 8. The only blocker I see is what @desrosj raised a few weeks back that we should keep the same versions as in WordPress Core to ensure it builds correctly with the infrastructre in place.

alexstine · 2021-11-22T19:12:54Z

@gziolo If I change to v14, will it allow us to get this in sooner? Every time I face issues with this and I have to imagine others do as well. This also updates the all important docs to better reflect the versions.

gziolo · 2021-11-22T19:48:11Z

@gziolo If I change to v14, will it allow us to get this in sooner? Every time I face issues with this and I have to imagine others do as well. This also updates the all important docs to better reflect the versions.

Yes, it's also what @youknowriad did for wp/5.8 branch a few days ago:

https://github.com/WordPress/gutenberg/blob/wp/5.8/.nvmrc

and what we did in the past (version number used changes over time) for branches containing code for older major WordPress releases.

Using LTS sounds great in overall, but the change happens once per year, so maybe it's fine to apply the change explicitly with a PR like this one.

gziolo · 2021-11-22T19:53:12Z

docs/contributors/code/getting-started-with-code-contribution.md

@@ -5,7 +5,7 @@ The following guide is for setting up your local environment to contribute to th
 ## Prerequisites

 -   Node.js
-    Gutenberg is a JavaScript project and requires [Node.js](https://nodejs.org/). The project is built using the latest active LTS release of node, and the latest version of NPM. See the [LTS release schedule](https://github.com/nodejs/Release#release-schedule) for details.
+    Gutenberg is a JavaScript project and requires [Node.js](https://nodejs.org/). The project is built using the version (14.18.1) release of node, and the latest version of NPM. See the [LTS release schedule](https://github.com/nodejs/Release#release-schedule) for details.


At the moment we also use npm v6 rather than the latest one.

gziolo · 2021-11-22T19:58:58Z

docs/getting-started/devenv/README.md

@@ -21,10 +21,10 @@ curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
 ```

 Quit and restart terminal
-Install the long-term support (lts) version of node.
+Install node version (14.18.1).


I think we can keep this paragraph as is. See https://nodejs.org/en/about/releases/. Node 14 is considered Maintenance LTS release.

alexstine · 2021-11-22T20:01:59Z

@gziolo What do you think of latest changes? I updated things so I am more generically using v14. I am not sure about keeping that one LTS line the same as I feel it may be a bit confusing. Thoughts?

gziolo · 2021-11-22T20:10:04Z

@mkaz and @ryanwelcher, would you mind helping polishing the documentation changes? 😄

The part where we use 14 as the Node.js version is solid 👍🏻

…pdate/node-version-info

alexstine · 2021-11-22T21:18:59Z

Thanks @gziolo .

Also, managed to get the checks to pass again. 👍

gziolo

Let's use consistently v6 and v14 for versions based on the Node.js releases page:

https://nodejs.org/en/about/releases/

docs/contributors/code/getting-started-with-code-contribution.md

docs/getting-started/devenv/README.md

gziolo

@alexstine, thank you for wrangling these changes, much appreciated 🙇🏻

gziolo · 2021-11-23T14:47:16Z

@noisysocks, you might want to cherry-pick this PR to the 5.9 release. It's going to be necessary at some point when we create wp/5.9 branch to ensure that the Node.js version is pinned to v14 forever 😄

gziolo · 2021-11-23T14:52:43Z

I have just tested with the latest trunk and it works like a charm 🎉

…36744) * Documentation updates and better NVM support. * Be more generic about version 14. * Merge trunk in to branch. * Apply suggestions from code review Co-authored-by: Greg Ziółkowski <grzegorz@gziolo.pl>

Documentation updates and better NVM support.

b7e1908

alexstine requested review from ajitbohra and mkaz as code owners November 22, 2021 17:40

alexstine self-assigned this Nov 22, 2021

alexstine requested review from tellthemachines, noisysocks, talldan and youknowriad November 22, 2021 17:41

youknowriad requested a review from gziolo November 22, 2021 17:44

gziolo reviewed Nov 22, 2021

View reviewed changes

Be more generic about version 14.

f6a05ab

gziolo reviewed Nov 22, 2021

View reviewed changes

alexstine added 2 commits November 22, 2021 15:16

Merge branch 'trunk' of https://github.com/wordpress/gutenberg into u…

b237e84

…pdate/node-version-info

Merge trunk in to branch.

6e16793

gziolo approved these changes Nov 23, 2021

View reviewed changes

gziolo reviewed Nov 23, 2021

View reviewed changes

docs/getting-started/devenv/README.md Outdated Show resolved Hide resolved

gziolo reviewed Nov 23, 2021

View reviewed changes

docs/getting-started/devenv/README.md Outdated Show resolved Hide resolved

Apply suggestions from code review

37d26bf

gziolo approved these changes Nov 23, 2021

View reviewed changes

gziolo merged commit 1714d93 into WordPress:trunk Nov 23, 2021

github-actions bot added this to the Gutenberg 12.1 milestone Nov 23, 2021

gziolo mentioned this pull request Nov 23, 2021

Update .nvmrc to use node 14 #36384

Closed

dcalhoun mentioned this pull request Nov 23, 2021

Use Node.js v14 wordpress-mobile/gutenberg-mobile#4280

Merged

2 tasks

noisysocks added Backport to WP 6.7 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta and removed Backport to WP 6.7 Beta/RC Pull request that needs to be backported to the WordPress major release that's currently in beta labels Nov 25, 2021

noisysocks mentioned this pull request Nov 29, 2021

Update @wordpress packages WordPress/wordpress-develop#1967

Closed

westonruter mentioned this pull request Nov 30, 2021

Update Gutenberg packages after v12.0.1 release ampproject/amp-wp#6745

Merged

ellatrix mentioned this pull request Aug 9, 2022

Use Node v16 #43091

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Change .nvmrc and documentation for Node.js version (LTS to 14.18.1) #36744

Change .nvmrc and documentation for Node.js version (LTS to 14.18.1) #36744

alexstine commented Nov 22, 2021 •

edited

Loading

gziolo commented Nov 22, 2021

alexstine commented Nov 22, 2021

gziolo commented Nov 22, 2021 •

edited

Loading

gziolo Nov 22, 2021

gziolo Nov 22, 2021

alexstine commented Nov 22, 2021

gziolo commented Nov 22, 2021

alexstine commented Nov 22, 2021

gziolo left a comment

gziolo left a comment

gziolo commented Nov 23, 2021

gziolo commented Nov 23, 2021

Change .nvmrc and documentation for Node.js version (LTS to 14.18.1) #36744

Change .nvmrc and documentation for Node.js version (LTS to 14.18.1) #36744

Conversation

alexstine commented Nov 22, 2021 • edited Loading

Description

Why the Change?

How has this been tested?

Screenshots

Types of changes

Checklist:

gziolo commented Nov 22, 2021

alexstine commented Nov 22, 2021

gziolo commented Nov 22, 2021 • edited Loading

gziolo Nov 22, 2021

Choose a reason for hiding this comment

gziolo Nov 22, 2021

Choose a reason for hiding this comment

alexstine commented Nov 22, 2021

gziolo commented Nov 22, 2021

alexstine commented Nov 22, 2021

gziolo left a comment

Choose a reason for hiding this comment

gziolo left a comment

Choose a reason for hiding this comment

gziolo commented Nov 23, 2021

gziolo commented Nov 23, 2021

alexstine commented Nov 22, 2021 •

edited

Loading

gziolo commented Nov 22, 2021 •

edited

Loading