Skip to content

Use the same Node version as VSCode#1374

Merged
elenatanasoiu merged 2 commits intomainfrom
elenatanasoiu/set-node-version
Jun 13, 2022
Merged

Use the same Node version as VSCode#1374
elenatanasoiu merged 2 commits intomainfrom
elenatanasoiu/set-node-version

Conversation

@elenatanasoiu
Copy link
Copy Markdown
Contributor

@elenatanasoiu elenatanasoiu commented Jun 1, 2022

As recommended here #1369 (comment), we want to stay in sync with the current node version shipped with VSCode (v16.13.0).

For this we can add a .nvmrc file to alert nvm to switch to the preferred version automatically.

It will also help prevent builds from failing when setting up the project for the first time, as building the extension currently fails in Node v18: #1373

We're also updating the docs to mention using nvm to manage node versions.

Checklist

  • CHANGELOG.md has been updated to incorporate all user visible changes made by this pull request.
  • Issues have been created for any UI or other user-facing changes made by this pull request.
  • [Maintainers only] If this pull request makes user-facing changes that require documentation changes, open a corresponding docs pull request in the github/codeql repo and add the ready-for-doc-review label there.

@elenatanasoiu elenatanasoiu requested a review from a team as a code owner June 1, 2022 11:49
@elenatanasoiu elenatanasoiu requested a review from a team June 1, 2022 11:49
@elenatanasoiu elenatanasoiu force-pushed the elenatanasoiu/set-node-version branch from 1bcd800 to 1149593 Compare June 1, 2022 13:02
@elenatanasoiu elenatanasoiu force-pushed the elenatanasoiu/set-node-version branch 4 times, most recently from 1acebc6 to 3f96a37 Compare June 1, 2022 15:33
Copy link
Copy Markdown
Contributor

@aeisenberg aeisenberg left a comment

Choose a reason for hiding this comment

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

I think this is generally the right approach, but doing this means we need to be more careful to update the node version requirement when versions in vscode change.

Could you also add a note in the section on releasing in contributing.md to verify the required version of node with the version that vscode uses? And this note should specify all the places that need to be updated when there is a change.

@elenatanasoiu elenatanasoiu force-pushed the elenatanasoiu/set-node-version branch from 3f96a37 to 8eb09be Compare June 1, 2022 18:38
@elenatanasoiu
Copy link
Copy Markdown
Contributor Author

@aeisenberg Thanks for the review 💐 I've applied the changes you suggested.

@aeisenberg
Copy link
Copy Markdown
Contributor

Thanks for the changes. There's one more thing, about updating CONTRIBUTING.md with a new release step. See my comment above.

As recommended here #1369 (comment), we want to stay in sync with the current node version shipped with
VSCode (v16.13.0):

https://github.com/microsoft/vscode/blob/32d40cf44e893e87ac33ac4f08de1e5f7fe077fc/remote/.yarnrc#L2

For this we can add a `.nvmrc` file to alert nvm to switch to the preferred version automatically.

It will also help prevent builds from failing when setting up the project for the first time, as building the extension currently fails in Node v18: #1373

We're also updating the docs to mention using `nvm` to manage node versions and point to the right place to check for current supported versions.
As recommended here #1369 (comment), since the current build for this extension does not work with Node v18 #1373, it would be good to set a maximum node version until this gets addressed.

So we're updating `engines` here to allow for a maximum version, which in this case is v17.0.0.
@elenatanasoiu elenatanasoiu force-pushed the elenatanasoiu/set-node-version branch from 8eb09be to 5f21594 Compare June 13, 2022 10:21
@elenatanasoiu
Copy link
Copy Markdown
Contributor Author

Thanks @aeisenberg, I've added an extra step here.

@elenatanasoiu elenatanasoiu merged commit a9922b8 into main Jun 13, 2022
@elenatanasoiu elenatanasoiu deleted the elenatanasoiu/set-node-version branch June 13, 2022 14:54
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.

2 participants