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

🐛 Bug Report: Install Docs out of date - npm LTS is now 18 #14541

Closed
2 tasks done
dgiacomo opened this issue Nov 9, 2022 · 4 comments
Closed
2 tasks done

🐛 Bug Report: Install Docs out of date - npm LTS is now 18 #14541

dgiacomo opened this issue Nov 9, 2022 · 4 comments
Labels
bug Something isn't working

Comments

@dgiacomo
Copy link
Contributor

dgiacomo commented Nov 9, 2022

📜 Description

On 2022-10-25 npm version 18 became the new LTS version. Yarn expects either 14 or 16. https://github.com/nodejs/release#release-schedule

Aspiration of the project seems to be to keep on pace with the latest npm LTS release, but it is slightly behind. The engine "node" is incompatible with this module. Expected version "14 || 16". Got "18.12.1"

I couldn't find any other issues referencing this and wonder if this is the first major switch over of this sort. Should the docs be updated to call out targeting 16 for now or is work in play to move to 18? I'm guessing this can be painful as it might impact installations that are currently out there.

My intent of filing this was to get a place holder started that others could look at to get a sense of what to expect / foster discussion and see if the docs need temporary updates. If there is discussion outside of Github or if it missed it, my apologies.

It's pretty easy to see what the issue is and switch to 16, but surfacing the larger challenge of intent to switch to new LTS is what I was hoping to ask about since I couldn't find anything on quick search.

👍 Expected behavior

Followed docs:
nvm install --lts npm install --global yarn npx @backstage/create-app
NPM 18 installed - hit error that 14 or 16 is required. Expected app creation to succeed.

Docs could be updated with version 16 (replacing references like nvm install --lts) or a link could be added to refer to an Issue documenting work in progress to upgrade the accepted versions of Node

👎 Actual Behavior with Screenshots

Followed docs for creating app:
nvm install --lts npm install --global yarn npx @backstage/create-app
Got this errror:
executing yarn install ◝ error root@1.0.0: The engine "node" is incompatible with this module. Expected version "14 || 16". Got "18.12.1" error Found incompatible module.

👟 Reproduction steps

nvm install --lts npm install --global yarn npx @backstage/create-app

📃 Provide the context for the Bug.

nvm install --lts npm install --global yarn npx @backstage/create-app

🖥️ Your Environment

OSX
NVM: 16.18.1

👀 Have you spent some time to check if this bug has been raised before?

  • I checked and didn't find similar issue

🏢 Have you read the Code of Conduct?

Are you willing to submit PR?

Yes I am willing to submit a PR!

@dgiacomo dgiacomo added the bug Something isn't working label Nov 9, 2022
@awanlin
Copy link
Collaborator

awanlin commented Nov 9, 2022

Hi @dgiacomo, just a heads up that this was included in the weekly release for the next release line, specifically version 1.8.0-next.2 (came out yesterday) and this will be included in the monthly release of version 1.8.0 on the 15th (but I still get little confused on this date so it might be the 22nd)

https://github.com/backstage/backstage/blob/master/docs/releases/v1.8.0-next.2-changelog.md#patch-changes-14

@awanlin
Copy link
Collaborator

awanlin commented Nov 9, 2022

For reference here's the PR that started this back in July: #12558

@dgiacomo
Copy link
Contributor Author

dgiacomo commented Nov 9, 2022

thank you! addresses my comments and questions, especially around what to expect in terms of release cadence - apologies I didn't spot this.

https://github.com/backstage/backstage/pull/14421/files

@dgiacomo dgiacomo closed this as completed Nov 9, 2022
@awanlin
Copy link
Collaborator

awanlin commented Nov 9, 2022

You're welcome. The live version of the Release & Versioning Policy is here: https://backstage.io/docs/overview/versioning-policy

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants