Skip to content

[docs] Add link to the engines.node field definition. #1284

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

Closed

Conversation

mk-pmb
Copy link

@mk-pmb mk-pmb commented Apr 23, 2025

Description:
Added a link to the definition of the engines.node field in package.json.

Related issue:
Closes #1081.

Check list:

  • Mark if documentation changes are required.
  • Mark if tests were added or updated to cover the changes.

@mk-pmb mk-pmb requested a review from a team as a code owner April 23, 2025 22:27
@priyagupta108
Copy link
Contributor

priyagupta108 commented Apr 25, 2025

Hi @mk-pmb 👋,
Thanks for the PR and for adding the link to the npm documentation for the engines.node field! It's a helpful addition.

I did notice the phrasing:

"If volta.node isn't defined, then it will look for engines.node (as defined here in the npm docs)."

The reference to "as defined here in the npm docs" could be a little misleading. While the npm docs do describe how to use the engines.node field, they don’t explain the behavior of checking volta.node before engines.node.

It might be clearer to adjust the wording slightly to specify that the npm docs only define how engines.node is used, without implying they describe the full behavior of checking volta.node first.

Looking forward to your thoughts! 😊

@priyagupta108 priyagupta108 self-assigned this Apr 25, 2025
@mk-pmb mk-pmb force-pushed the docs-advanced-clarify-engines-field branch from 2a3a523 to d9c084e Compare April 26, 2025 08:05
@mk-pmb
Copy link
Author

mk-pmb commented Apr 26, 2025

Good catch! That could indeed be confusing. I updated the branch to insert a new line below the original,

(The latter is defined here in the npm docs.)

@priyagupta108
Copy link
Contributor

@mk-pmb, Thanks for your contribution! After reviewing the changes and the npm documentation, we feel the npm docs link isn’t necessary in this case.

When using the package.json input, the action first checks for volta.node and only falls back to engines.node if volta.node is not defined. This behavior is specific to the action and differs from how engines.node is used in npm. Since this behavior is already clearly explained in the setup-node documentation, we don’t believe the npm docs link adds significant value.

To keep the documentation focused on the action’s specific purpose, we’ve decided not to include the npm docs link. We’ll be closing the PR now, but please feel free to reach out if you have any concerns or further suggestions.

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.

docs: Node version file: Clarify effect of version range in engines.node
2 participants