Show HN: Guide so you can clean up all your Node Versions

4 months ago 7

Handy checklist for everywhere and anywhere you might need to set the version when upgrading to the latest Node.

MethodVercel BuildVercel ServerlessNetlify BuildNetlify ServerlessCloudflare PagesGitHub ActionsAWS LambdaDocker

Dashboard / UI	✅	✅	✅	✅	✅	🚫	✅	🚫
package.json engines	✅	✅	🚫	🚫	🚫	✅	🚫	🚫
.node-version	🚫	🚫	✅	✅	✅	🚫	🚫	🚫
.nvmrc	🚫	🚫	✅	✅	✅	🚫	🚫	🚫
NODE_VERSION env var	🚫	🚫	✅	🚫	✅	🚫	🚫	🚫
Custom TOML config	🚫	🚫	✅	🚫	🚫	🚫	🚫	🚫
CLI command	🚫	🚫	🚫	🚫	🚫	🚫	✅	🚫
.npmrc use-node-version	🚫	🚫	✅	🚫	✅	🚫	🚫	🚫
Custom YAML config	🚫	🚫	🚫	🚫	🚫	✅	🚫	🚫
Custom JSON config	🚫	🚫	🚫	🚫	🚫	🚫	🚫	🚫
Custom config file	🚫	🚫	🚫	🚫	🚫	🚫	🚫	✅

Where Node Version gets set

Here's the comprehensive list with code examples, using Node version 24 as the example:

// package.json { "engines": { "node": "24.x" } } // https://docs.npmjs.com/cli/configuring-npm/package-json#engines

Works for CloudFlare Pages and Netlify

// .nvmrc 24 // https://github.com/nvm-sh/nvm#nvmrc

Works for CloudFlare Pages and Netlify

// .node-version 24 // https://github.com/shadowspawn/node-version-usage

// .npmrc use-node-version=24 // https://docs.npmjs.com/cli/configuring-npm/npmrc

# .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'

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

⭐️ Setting .node-version or .nvmrc will override the version set in the Netlify UI.

# 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

Netlify Runtime/Serverless Config

Unfortunately, as of June 2024 this can only be set in the Netlify UI.

AWS_LAMBDA_JS_RUNTIME=nodejs24.x

Netlify Runtime Node Version Support Lambda Versions

npm install --save-dev @types/node@24 pnpm add --dev @types/node@24 # https://www.npmjs.com/package/@types/node

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
AWS CLI:

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

# Dockerfile FROM node:24 # https://docs.docker.com/samples/node/

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

# .circleci/config.yml version: 2.1 jobs: build: docker: - image: circleci/node@5 steps: - checkout - node/install: node-version: '24'

CircleCI Node.js Version

⭐️ If you don't specify a Node version, Travis CI will use the default to the version set in .nvmrc

# .travis.yml language: node_js node_js: - "24"

TravisCI Node.js Version

AWS Elastic Beanstalk(unverified)

Update the Node version in the platform configuration via the AWS Management Console or CLI.

AWS Console: Link to Console
AWS CLI:

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
Google Cloud CLI:

gcloud functions deploy my-function --runtime nodejs24 # https://cloud.google.com/functions/docs/concepts/nodejs-runtime

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.

Read Entire Article