3.1 KiB
title | description |
---|---|
Node.js Versions | Node versions support in Renovate |
Node.js Versions
Renovate can upgrade the Node.js runtime used by your project so that you're using the latest bug fixes, performance improvements, security mitigations, etc. that meet your project's unique needs.
File Support
Renovate is capable of managing the Node.js version in the following files:
- The
engines
field inpackage.json
. - The
volta
field inpackage.json
. - The
.nvmrc
file for the Node Version Manager. - The
node_js
field in.travis.yml
.
How It Works
Node.js renovation in package.json > engines
and in .nvmrc
is enabled by default, if your existing version is pinned.
To enable .travis.yml
renovation, you must:
- Enable Travis renovation explicitly by setting the following Renovate configuration:
"travis": { "enabled": true }
- Optionally, configure a support policy (As documented below).
When Renovate processes your project's repository it will look for the files listed above and submit a single pull request that upgrades all Node.js versions simulteniously.
Configuring Support Policy
Renovate supports a supportPolicy
option that can be passed the following values and associated versions (current as of May 2019):
Default: lts
supportPolicy | versions | description |
---|---|---|
all | 8,10,11,12 | All releases that have not passed their end date |
lts | 8,10 | All releases classified as LTS, including in maintenance |
active | 10,12 | All releases not in maintenance |
lts_active | 10 | All releases both LTS and active |
lts_latest | 10 | The latest LTS release |
current | 12 | The latest release from "all" |
The version numbers associated with each support policy will be updated as new versions of Node.js are released, moved to LTS or maintenance, etc.
For example, to instruct Renovate to upgrade your project to the latest Long-term Support release, you can use the following configuration:
"supportPolicy": ["lts_latest"]
It's best to define this support policy inside the node
configuration object so that it is applied to all Node.js-related files.
For additional language support see the supportPolicy
documentation.