feat: default node version to .nvmrc when available, fixes #6071 #6108
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
1 task
|
Download the artifacts for this pull request:
See Testing a PR. |
GuySartorelli
force-pushed
the
20240417_GuySartorelli_nodejs-default-to-nvmrc
branch
from
d6fdd9e
to
66a38aa
Compare
|
Marking as draft as there have been concerns raised around this approach in the linked issue. |
|
I'm open to general solutions to this issue, but unfortunately the problem with .nvmrc is that it pushes nvm onto people, and that certainly is not a majority workflow. We don't need to integrate one population's workflow onto another population. Closing this for now, we can continue the conversation in the issue. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Issue
Projects with a
.nvmrcneed to duplicate the node version into DDEV config as well.When collaborating with developers who aren't using DDEV, there is a risk of the
.nvmrcvalue being updated without updating the reference in.ddev/config.yamlfor that project.There are other scenarios as well where this desync could be problematic.
How This PR Solves The Issue
If a
.nvmrcexists in the project root and nonodejs_versionis defined in the project's.ddev/config.yamlfile, the.nvmrcfile is used to define the default node js version.If that file doesn't exist, the existing hardcoded DDEV default value is used.
Manual Testing Instructions
Run
ddev statusin a project with/without a.nvmrcfile and see the nodejs version update.Validate that adding
nodejs_versionin config.yaml still overrides any default values.Automated Testing Overview
I'm not sure how to test this. Options include:
getNodeJSDefaulta public function so it can be called directly by testsRelated Issue Link(s)
nodejs_versionto use external file as reference for node version #6071Release/Deployment Notes
Projects which have a
.nvmrcfile in the project root and which have not explicitly defined the nodejs version for that project withnodejs_versionwill swap to using the version defined in.nvmrcinstead of the hardcoded DDEV default value.