Use engines.node as source of version data for actions/setup-node action #1029
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
per1234
added
type: imperfection
The actions/setup-node GitHub Actions action is used to set up Node.js in the GitHub Actions runner machine. The action supports obtaining the Node.js version to set up from the `engines.node` field of the package.json file. This allows us to define the standardized version of Node.js for use by project contributors in a single place rather than having to maintain multiple instances of that data.
This will produce an error if a contributor attempts to run an npm command in the project using an unsupported version of Node.js.
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.
A single standardized version of Node.js is used for all development work in this repository, both by contributors and the automated validation systems.
The actions/setup-node GitHub Actions action is used to set up Node.js in the GitHub Actions runner machine.
The action supports obtaining the Node.js version to set up from the
engines.nodefield of thepackage.jsonfile:https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md#node-version-file
This allows us to define the standardized version of Node.js for use by project contributors in a single place rather than having to maintain multiple instances of that data.
We have proof of the importance of this because at the time the Node.js version used by the action was bumped (#919), the Node.js version used by the GitHub Actions workflows was only updated in half the workflows, leaving the project infrastructure in an inconsistent state where it used a mixture of 20.x and 16.x.
Once the Node.js version is defined in npm can then be configured to enforce the use of the standard Node.js version by contributors by setting the
engine-strictconfiguration key in the.npmrcconfiguration file.