HonkingGoose
f72fb854be
* split up long sentence * use active voice * use 1's for ordered list, fix whitespace * split sentence, and rewrite in active voice * Implement review suggestion Co-authored-by: Rhys Arkins <rhys@arkins.net> Co-authored-by: Rhys Arkins <rhys@arkins.net>
3.1 KiB
title, description
| title | description |
|---|---|
| Node.js Versions | Node.js versions support in Renovate |
Node.js Versions
Renovate can upgrade the Node.js runtime used by your project. This way you're using the latest bug fixes, performance improvements, security mitigations, etc.
File Support
Renovate can manage the Node.js version in the following files:
- The
enginesfield inpackage.json - The
voltafield inpackage.json - The
.nvmrcfile for the Node Version Manager - The
node_jsfield 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 simultaneously.
Configuring Support Policy
Renovate supports a supportPolicy option that can be passed the following values and associated versions (current as of Nov 2020):
Default: lts
| supportPolicy | versions | description |
|---|---|---|
| all | 10, 12, 14, 15 | All releases that have not passed their end date |
| lts | 10, 12, 14 | All releases classified as LTS, including in maintenance |
| active | 12, 14, 15 | All releases not in maintenance |
| lts_active | 12, 14 | All releases both LTS and active |
| lts_latest | 14 | The latest LTS release |
| current | 15 | 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"]
We recommend that you define this support policy inside the node configuration object.
This way, it is applied to all Node.js-related files.
For additional language support see the supportPolicy documentation.