https://github.com/thatguysam/node-upgrade-checklist
Handy checklist for everywhere and anywhere you might need to set the version when upgrading to the latest Node.
https://github.com/thatguysam/node-upgrade-checklist
aws-lambda netlify node nodejs nvm nvmrc pnpm vercel
Last synced: about 1 month ago
JSON representation
Handy checklist for everywhere and anywhere you might need to set the version when upgrading to the latest Node.
- Host: GitHub
- URL: https://github.com/thatguysam/node-upgrade-checklist
- Owner: ThatGuySam
- Created: 2024-06-07T14:24:07.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-02T17:33:26.000Z (12 months ago)
- Last Synced: 2026-03-01T17:56:58.354Z (3 months ago)
- Topics: aws-lambda, netlify, node, nodejs, nvm, nvmrc, pnpm, vercel
- Homepage:
- Size: 34.2 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node Upgrade Checklist
Handy checklist for everywhere and anywhere you might need to set the version when upgrading to the latest Node.
[Fixes and Updates Welcome](https://github.com/ThatGuySam/node-upgrade-checklist/edit/main/README.md)
## Compatibility Table
| **Method** | **Vercel Build** | **Vercel Serverless** | **Netlify Build** | **Netlify Serverless** | **Cloudflare Pages** | **GitHub Actions** | **AWS Lambda** | **Docker** |
| ------------------------------- | :-------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------: | :----------------------------------------: | :--------------------------------------------------------------------: | :--------------------------------: |
| **Dashboard / UI** | [✅](https://vercel.com/docs/functions/runtimes/node-js/node-js-versions) | [✅](https://vercel.com/docs/functions/runtimes/node-js/node-js-versions) | [✅](https://docs.netlify.com/configure-builds/manage-dependencies/#node-js-and-javascript) | [✅](https://docs.netlify.com/functions/optional-configuration/#node-js-version-for-runtime-2) | [✅](https://developers.cloudflare.com/pages/configuration/build-image/#override-default-versions) | 🚫 | [✅](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) | 🚫 |
| **`package.json` engines** | [✅](https://vercel.com/docs/functions/runtimes/node-js/node-js-versions#version-overrides-in-packagejson) | [✅](https://vercel.com/docs/functions/runtimes/node-js/node-js-versions#version-overrides-in-packagejson) | 🚫 | 🚫 | 🚫 | [✅](https://github.com/actions/setup-node?tab=readme-ov-file#usage)| 🚫 | 🚫 |
| **.node-version** | 🚫 | 🚫 | [✅](https://docs.netlify.com/configure-builds/manage-dependencies/#node-js-and-javascript) | [✅](https://docs.netlify.com/configure-builds/manage-dependencies/#node-js-and-javascript) | [✅](https://developers.cloudflare.com/pages/configuration/build-image/#languages-and-runtime) | 🚫 | 🚫 | 🚫 |
| **.nvmrc** | 🚫 | 🚫 | [✅](https://docs.netlify.com/configure-builds/manage-dependencies/#node-js-and-javascript) | [✅](https://docs.netlify.com/configure-builds/manage-dependencies/#node-js-and-javascript) | [✅](https://developers.cloudflare.com/pages/configuration/build-image/#languages-and-runtime) | 🚫 | 🚫 | 🚫 |
| **`NODE_VERSION` env var** | 🚫 | 🚫 | [✅](https://docs.netlify.com/configure-builds/manage-dependencies/#node-js-and-javascript) | 🚫 | [✅](https://developers.cloudflare.com/pages/configuration/build-image/#languages-and-runtime) | 🚫 | 🚫 | 🚫 |
| **Custom TOML config** | 🚫 | 🚫 | [✅](https://docs.netlify.com/configure-builds/file-based-configuration/) | 🚫 | 🚫 | 🚫 | 🚫 | 🚫 |
| **CLI command** | 🚫 | 🚫 | 🚫 | 🚫 | 🚫 | 🚫 | [✅](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) | 🚫 |
| **`.npmrc` `use-node-version`** | 🚫 | 🚫 | [✅](https://pnpm.io/9.x/npmrc#use-node-version) | 🚫 | [✅](https://pnpm.io/9.x/npmrc#use-node-version) | 🚫 | 🚫 | 🚫 |
| **Custom config file** | 🚫 | 🚫 | 🚫 | 🚫 | 🚫 | [✅](https://github.com/actions/setup-node) | 🚫 | [✅](https://hub.docker.com/_/node) |
## Where Node Version gets set
Here's the comprehensive list with code examples, using Node version 24 as the example:
### **`package.json` Engines**
```JavaScript
// package.json
{
"engines": {
"node": "24.x"
}
}
// https://docs.npmjs.com/cli/configuring-npm/package-json#engines
```
### **`.nvmrc`**
Works for [CloudFlare Pages](https://developers.cloudflare.com/pages/configuration/build-image/#languages-and-runtime) and [Netlify](https://docs.netlify.com/configure-builds/manage-dependencies/)
```
// .nvmrc
24
// https://github.com/nvm-sh/nvm#nvmrc
```
### **`.node-version`**
Works for [CloudFlare Pages](https://developers.cloudflare.com/pages/configuration/build-image/#languages-and-runtime) and [Netlify](https://docs.netlify.com/configure-builds/manage-dependencies/)
```
// .node-version
24
// https://github.com/shadowspawn/node-version-usage
```
### **`.npmrc`**
```
// .npmrc
use-node-version=24
// https://docs.npmjs.com/cli/configuring-npm/npmrc
```
### **GitHub Actions**
```yaml
# .github/workflows/ci.yml
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Set up Node.js
# Docs - https://github.com/actions/setup-node
uses: actions/setup-node@v2
with:
# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs#specifying-the-nodejs-versionz
# It also admits such aliases as lts/*, latest, nightly and canary builds
# This means less maintenance if you don't like manually updating versions
# Examples: 12.x, 10.15.1, >=10.15.0, lts/Hydrogen, 16-nightly, latest, node
node-version: '24'
```
### **Dependency Managers**
Reminder: Run `npm install`, `pnpm install`, etc... after updating the Node version to ensure dependencies are compatible.
### **Vercel Build and Serverless Config**
⭐️ Defaults to Node Version in package.json/engines
https://vercel.com/docs/project-configuration#project-configuration/build
[Available Node Versions](https://vercel.com/docs/functions/runtimes/node-js#default-and-available-versions)
### **Netlify Build Config**
⭐️ Setting .node-version or .nvmrc will override the version set in the Netlify UI.
```toml
# netlify.toml
[context.production]
environment = { NODE_VERSION = "24.0.0" }
# https://docs.netlify.com/configure-builds/manage-dependencies/#node-js-and-javascript
```
[Netlify TOML file reference](https://docs.netlify.com/configure-builds/file-based-configuration/)
### **Netlify Runtime/Serverless Config**
Unfortunately, as of June 2024 this can only be set in the Netlify UI.
```bash
AWS_LAMBDA_JS_RUNTIME=nodejs24.x
```
[Netlify Runtime Node Version](https://docs.netlify.com/functions/optional-configuration/?fn-language=js#node-js-version-for-runtime-2)
[Support Lambda Versions](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#w364aac19c29)
### **Update `@types/node`**
```bash
npm install --save-dev @types/node@24
pnpm add --dev @types/node@24
# https://www.npmjs.com/package/@types/node
```
### **AWS Lambda**
AWS Lambda uses the `runtime` parameter in the function configuration. Update it via the AWS Management Console or AWS CLI.
- AWS Console: [Link to Console](https://console.aws.amazon.com/lambda/home)
- AWS CLI:
```bash
aws lambda update-function-configuration --function-name my-function --runtime nodejs24.x
# https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html
```
[Support Lambda Versions](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#w364aac19c29)
### **Dockerfile**
```dockerfile
# Dockerfile
FROM node:24
# https://docs.docker.com/samples/node/
```
### **Heroku**
To specify the version of Node.js to use on Heroku, use the engines section of the package.json. Drop the v to save only the version number.
[Heroku Node.js Version](https://devcenter.heroku.com/articles/nodejs-support#specifying-a-node-js-version)
### **CircleCI**
```yaml
# .circleci/config.yml
version: 2.1
jobs:
build:
docker:
- image: circleci/node@5
steps:
- checkout
- node/install:
node-version: '24'
```
[CircleCI Node.js Version](https://circleci.com/docs/language-javascript/)
### **TravisCI**
⭐️ If you don't specify a Node version, Travis CI will use the default to the version set in `.nvmrc`
```yaml
# .travis.yml
language: node_js
node_js:
- "24"
```
[TravisCI Node.js Version](https://docs.travis-ci.com/user/languages/javascript-with-nodejs/)
### **AWS Elastic Beanstalk(unverified)**
Update the Node version in the `platform` configuration via the AWS Management Console or CLI.
- AWS Console: [Link to Console](https://console.aws.amazon.com/elasticbeanstalk/home)
- AWS CLI:
```bash
aws elasticbeanstalk update-environment --environment-name my-env --option-settings Namespace=aws:elasticbeanstalk:container:nodejs,OptionName=NodeVersion,Value=24
# https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-linux.html#platforms-linux.nodejs
```
### **Google Cloud Functions(unverified)**
Set `engines.node` in `package.json` as shown in item 1.
- Google Cloud Console: [Link to Console](https://console.cloud.google.com/functions/)
- Google Cloud CLI:
```bash
gcloud functions deploy my-function --runtime nodejs24
# https://cloud.google.com/functions/docs/concepts/nodejs-runtime
```
### Summary Output
Ensure the CLI tool provides an output summary of all changes made, listing the files and their updated values. This helps in verifying the updates and troubleshooting any issues.
By following this comprehensive checklist and utilizing the code examples, you can ensure a smooth transition to a new Node version across various environments and configurations.