{"id":17187536,"url":"https://github.com/thatguysam/node-upgrade-checklist","last_synced_at":"2026-04-30T00:35:11.471Z","repository":{"id":243248661,"uuid":"811900897","full_name":"ThatGuySam/node-upgrade-checklist","owner":"ThatGuySam","description":"Handy checklist for everywhere and anywhere you might need to set the version when upgrading to the latest Node. ","archived":false,"fork":false,"pushed_at":"2025-07-02T17:33:26.000Z","size":35,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-01T17:56:58.354Z","etag":null,"topics":["aws-lambda","netlify","node","nodejs","nvm","nvmrc","pnpm","vercel"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ThatGuySam.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-07T14:24:07.000Z","updated_at":"2025-08-18T19:58:18.000Z","dependencies_parsed_at":"2024-06-07T16:13:44.515Z","dependency_job_id":null,"html_url":"https://github.com/ThatGuySam/node-upgrade-checklist","commit_stats":null,"previous_names":["thatguysam/node-upgrade-checklist"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/ThatGuySam/node-upgrade-checklist","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatGuySam%2Fnode-upgrade-checklist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatGuySam%2Fnode-upgrade-checklist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatGuySam%2Fnode-upgrade-checklist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatGuySam%2Fnode-upgrade-checklist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ThatGuySam","download_url":"https://codeload.github.com/ThatGuySam/node-upgrade-checklist/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ThatGuySam%2Fnode-upgrade-checklist/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32450187,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-29T22:27:22.272Z","status":"ssl_error","status_checked_at":"2026-04-29T22:10:49.234Z","response_time":110,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["aws-lambda","netlify","node","nodejs","nvm","nvmrc","pnpm","vercel"],"created_at":"2024-10-15T01:06:37.576Z","updated_at":"2026-04-30T00:35:11.465Z","avatar_url":"https://github.com/ThatGuySam.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Node Upgrade Checklist\nHandy checklist for everywhere and anywhere you might need to set the version when upgrading to the latest Node. \n\n\n[Fixes and Updates Welcome](https://github.com/ThatGuySam/node-upgrade-checklist/edit/main/README.md)\n\n\n\n## Compatibility Table\n\n| **Method**                      | **Vercel Build**                                                                                          | **Vercel Serverless**                                                                                     | **Netlify Build**                                                                          | **Netlify Serverless**                                                                        | **Cloudflare Pages**                                                                              | **GitHub Actions**                         | **AWS Lambda**                                                         | **Docker**                         |\n| ------------------------------- | :-------------------------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------------------: | :----------------------------------------------------------------------------------------: | :-------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------: | :----------------------------------------: | :--------------------------------------------------------------------: | :--------------------------------: |\n| **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) |                 🚫                 |\n| **`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)|                                   🚫                                   |                 🚫                 |\n| **.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)     |                     🚫                     |                                   🚫                                   |                 🚫                 |\n| **.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)     |                     🚫                     |                                   🚫                                   |                 🚫                 |\n| **`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)     |                     🚫                     |                                   🚫                                   |                 🚫                 |\n| **Custom TOML config**          |                                            🚫                                                             |                                            🚫                                                             | [✅](https://docs.netlify.com/configure-builds/file-based-configuration/)                   |                                              🚫                                               |                                               🚫                                                |                     🚫                     |                                   🚫                                   |                 🚫                 |\n| **CLI command**                 |                                            🚫                                                             |                                            🚫                                                             |                                             🚫                                             |                                              🚫                                               |                                               🚫                                                |                     🚫                     | [✅](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html) |                 🚫                 |\n| **`.npmrc` `use-node-version`** |                                            🚫                                                             |                                            🚫                                                             | [✅](https://pnpm.io/9.x/npmrc#use-node-version)                                            |                                              🚫                                               | [✅](https://pnpm.io/9.x/npmrc#use-node-version)                                                   |                     🚫                     |                                   🚫                                   |                 🚫                 |\n| **Custom config file**          |                                            🚫                                                             |                                            🚫                                                             |                                             🚫                                             |                                              🚫                                               |                                               🚫                                                | [✅](https://github.com/actions/setup-node) |                                   🚫                                   | [✅](https://hub.docker.com/_/node) |\n\n\n\n\n\n## Where Node Version gets set\n\n\nHere's the comprehensive list with code examples, using Node version 24 as the example:\n\n### **`package.json` Engines**\n```JavaScript\n// package.json\n{\n  \"engines\": {\n    \"node\": \"24.x\"\n  }\n}\n// https://docs.npmjs.com/cli/configuring-npm/package-json#engines\n```\n\n### **`.nvmrc`**\nWorks for [CloudFlare Pages](https://developers.cloudflare.com/pages/configuration/build-image/#languages-and-runtime) and [Netlify](https://docs.netlify.com/configure-builds/manage-dependencies/)\n```\n// .nvmrc\n24\n// https://github.com/nvm-sh/nvm#nvmrc\n```\n\n### **`.node-version`**\nWorks for [CloudFlare Pages](https://developers.cloudflare.com/pages/configuration/build-image/#languages-and-runtime) and [Netlify](https://docs.netlify.com/configure-builds/manage-dependencies/)\n```\n// .node-version\n24\n// https://github.com/shadowspawn/node-version-usage\n```\n\n### **`.npmrc`**\n```\n// .npmrc\nuse-node-version=24\n// https://docs.npmjs.com/cli/configuring-npm/npmrc\n```\n\n### **GitHub Actions**\n```yaml\n# .github/workflows/ci.yml\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Set up Node.js\n        # Docs - https://github.com/actions/setup-node\n        uses: actions/setup-node@v2\n        with:\n          # https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-nodejs#specifying-the-nodejs-versionz\n          # It also admits such aliases as lts/*, latest, nightly and canary builds\n          # This means less maintenance if you don't like manually updating versions\n          # Examples: 12.x, 10.15.1, \u003e=10.15.0, lts/Hydrogen, 16-nightly, latest, node\n          node-version: '24'\n```\n\n### **Dependency Managers**\nReminder: Run `npm install`, `pnpm install`, etc... after updating the Node version to ensure dependencies are compatible.\n\n### **Vercel Build and Serverless Config**\n⭐️ Defaults to Node Version in package.json/engines\nhttps://vercel.com/docs/project-configuration#project-configuration/build\n[Available Node Versions](https://vercel.com/docs/functions/runtimes/node-js#default-and-available-versions)\n\n### **Netlify Build Config**\n⭐️ Setting .node-version or .nvmrc will override the version set in the Netlify UI. \n```toml\n# netlify.toml\n[context.production]\n  environment = { NODE_VERSION = \"24.0.0\" }\n# https://docs.netlify.com/configure-builds/manage-dependencies/#node-js-and-javascript\n```\n[Netlify TOML file reference](https://docs.netlify.com/configure-builds/file-based-configuration/)\n\n\n### **Netlify Runtime/Serverless Config**\nUnfortunately, as of June 2024 this can only be set in the Netlify UI. \n```bash\nAWS_LAMBDA_JS_RUNTIME=nodejs24.x\n```\n[Netlify Runtime Node Version](https://docs.netlify.com/functions/optional-configuration/?fn-language=js#node-js-version-for-runtime-2)\n[Support Lambda Versions](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#w364aac19c29)\n\n\n### **Update `@types/node`**\n```bash\nnpm install --save-dev @types/node@24\npnpm add --dev @types/node@24\n# https://www.npmjs.com/package/@types/node\n```\n\n### **AWS Lambda**\nAWS Lambda uses the `runtime` parameter in the function configuration. Update it via the AWS Management Console or AWS CLI.\n\n- AWS Console: [Link to Console](https://console.aws.amazon.com/lambda/home)\n- AWS CLI:\n```bash\naws lambda update-function-configuration --function-name my-function --runtime nodejs24.x\n# https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html\n```\n[Support Lambda Versions](https://docs.aws.amazon.com/lambda/latest/dg/lambda-runtimes.html#w364aac19c29)\n\n### **Dockerfile**\n```dockerfile\n# Dockerfile\nFROM node:24\n# https://docs.docker.com/samples/node/\n```\n\n### **Heroku**\nTo 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.\n[Heroku Node.js Version](https://devcenter.heroku.com/articles/nodejs-support#specifying-a-node-js-version)\n\n### **CircleCI**\n```yaml\n# .circleci/config.yml\nversion: 2.1\njobs:\n  build:\n    docker:\n      - image: circleci/node@5\n    steps:\n      - checkout\n      - node/install:\n          node-version: '24'\n```\n[CircleCI Node.js Version](https://circleci.com/docs/language-javascript/)\n\n### **TravisCI**\n⭐️ If you don't specify a Node version, Travis CI will use the default to the version set in `.nvmrc`\n```yaml\n# .travis.yml\nlanguage: node_js\nnode_js:\n  - \"24\"\n```\n[TravisCI Node.js Version](https://docs.travis-ci.com/user/languages/javascript-with-nodejs/)\n\n### **AWS Elastic Beanstalk(unverified)**\nUpdate the Node version in the `platform` configuration via the AWS Management Console or CLI.\n\n- AWS Console: [Link to Console](https://console.aws.amazon.com/elasticbeanstalk/home)\n- AWS CLI:\n```bash\naws elasticbeanstalk update-environment --environment-name my-env --option-settings Namespace=aws:elasticbeanstalk:container:nodejs,OptionName=NodeVersion,Value=24\n# https://docs.aws.amazon.com/elasticbeanstalk/latest/dg/platforms-linux.html#platforms-linux.nodejs\n```\n\n### **Google Cloud Functions(unverified)**\nSet `engines.node` in `package.json` as shown in item 1.\n\n- Google Cloud Console: [Link to Console](https://console.cloud.google.com/functions/)\n- Google Cloud CLI:\n```bash\ngcloud functions deploy my-function --runtime nodejs24\n# https://cloud.google.com/functions/docs/concepts/nodejs-runtime\n```\n\n### Summary Output\nEnsure 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.\n\nBy 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.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthatguysam%2Fnode-upgrade-checklist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthatguysam%2Fnode-upgrade-checklist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthatguysam%2Fnode-upgrade-checklist/lists"}