Configure npm to enforce standard project Node.js version #791
Conversation
This file contains hidden or 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
This will produce an error if a contributor attempts to run an npm command in the project using an unsupported version of Node.js.
The "Check Website" workflow invokes the following chain of tasks:
1. `website:check`
2. `docs:generate`
3. `general:format-prettier`
This makes the Prettier tool a dependency of the workflow, which in turn introduces a dependency on npm, and thus on
Node.js.
Previously, the workflow didn't contain a step to run the "actions/setup-node" action, so it used whichever version of
npm happened to be installed in the runner machine, which happens to be 18.x currently. Now that the use of the
project's standard Node.js version 20.x is enforced, this caused the workflow to fail spuriously:
```
task: [npm:install-deps] npm install
npm error code EBADENGINE
npm error engine Unsupported engine
npm error engine Not compatible with your version of node/npm: undefined
npm error notsup Not compatible with your version of node/npm: undefined
npm error notsup Required: {"node":"20.x"}
npm error notsup Actual: {"npm":"10.7.0","node":"v18.20.4"}
```
The problem is solved by adding an "actions/setup-node" action step to the workflow to install the correct version of
Node.js.
per1234
added
type: enhancement
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.
This will produce an error if a contributor attempts to run an npm command in the project using an unsupported version
of Node.js.