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

docs: Node version file: Clarify effect of version range in engines.node #1081

Open
mk-pmb opened this issue Jun 12, 2024 · 3 comments
Open
Assignees
Labels
feature request New feature or request to improve the current logic

Comments

@mk-pmb
Copy link

mk-pmb commented Jun 12, 2024

Description:
In docs/advanced-usage.md#node-version-file, explain what effect "engines": { "node": ">=16.0.0" } would have had if it was not overridden by the volta option.

Justification:
I cannot tell from reading whether the example would install node 16, 20, 21 or 22.

Are you willing to submit a PR?
Yes.

@mk-pmb mk-pmb added feature request New feature or request to improve the current logic needs triage labels Jun 12, 2024
@HarithaVattikuti
Copy link
Contributor

Hello @mk-pmb
We appreciate your suggestion for a new feature! We'll make sure to address it when we have the opportunity

@priyagupta108
Copy link
Contributor

Hi @mk-pmb 👋, thank you for your feedback!

When "engines": { "node": ">=16.0.0" } is specified and not overridden by volta.node, the action will install the highest available version that satisfies this range, in line with SemVer guidelines. This could include versions like 16.x, 18.x, 20.x, or any newer version that meets the requirement.

For more details on how version matching works, please refer to the SemVer documentation on ranges.

I hope this clears things up! Please feel free to reach out if you have further questions or suggestions. We truly appreciate your input!

@mk-pmb
Copy link
Author

mk-pmb commented Apr 11, 2025

Thanks for the clarification! Next step would be to check if the example in the file still is confusing, and if so, add the clarification there. Maybe I can do that soon.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature request New feature or request to improve the current logic
Projects
None yet
Development

No branches or pull requests

3 participants