diff --git a/.circleci/config.yml b/.circleci/config.yml index b1248e4e..944fa83e 100644 --- a/.circleci/config.yml +++ b/.circleci/config.yml @@ -151,21 +151,21 @@ workflows: name: build-v<< matrix.node-version >> matrix: parameters: - node-version: [ "24.0", "22.13", "20.18" ] + node-version: [ "24.0", "22.13" ] - test: requires: - build-v<< matrix.node-version >> name: test-v<< matrix.node-version >> matrix: parameters: - node-version: [ "24.0", "22.13", "20.18" ] + node-version: [ "24.0", "22.13" ] - lint: requires: - build-v<< matrix.node-version >> name: lint-v<< matrix.node-version >> matrix: parameters: - node-version: [ "24.0", "22.13", "20.18" ] + node-version: [ "24.0", "22.13" ] - release-please: filters: <<: *filters_only_main @@ -183,7 +183,7 @@ workflows: name: build-v<< matrix.node-version >> matrix: parameters: - node-version: [ "24.0", "22.13", "20.18" ] + node-version: [ "24.0", "22.13" ] - test: filters: <<: *filters_release_build @@ -192,7 +192,7 @@ workflows: name: test-v<< matrix.node-version >> matrix: parameters: - node-version: [ "24.0", "22.13", "20.18" ] + node-version: [ "24.0", "22.13" ] - lint: filters: <<: *filters_release_build @@ -201,7 +201,7 @@ workflows: name: lint-v<< matrix.node-version >> matrix: parameters: - node-version: [ "24.0", "22.13", "20.18" ] + node-version: [ "24.0", "22.13" ] - publish: context: npm-publish-token filters: @@ -220,7 +220,7 @@ workflows: name: build-v<< matrix.node-version >> matrix: parameters: - node-version: [ "24.0", "22.13", "20.18" ] + node-version: [ "24.0", "22.13" ] - test: filters: <<: *filters_prerelease_build @@ -229,7 +229,7 @@ workflows: name: test-v<< matrix.node-version >> matrix: parameters: - node-version: [ "24.0", "22.13", "20.18" ] + node-version: [ "24.0", "22.13" ] - lint: filters: <<: *filters_prerelease_build @@ -238,7 +238,7 @@ workflows: name: lint-v<< matrix.node-version >> matrix: parameters: - node-version: [ "24.0", "22.13", "20.18" ] + node-version: [ "24.0", "22.13" ] - prepublish: context: npm-publish-token filters: @@ -261,7 +261,7 @@ workflows: name: build-v<< matrix.node-version >> matrix: parameters: - node-version: [ "24.0", "22.13", "20.18" ] + node-version: [ "24.0", "22.13" ] - test: requires: - build-v<< matrix.node-version >> @@ -269,4 +269,4 @@ workflows: name: test-v<< matrix.node-version >> matrix: parameters: - node-version: [ "24.0", "22.13", "20.18" ] + node-version: [ "24.0", "22.13" ] diff --git a/.github/workflows/commitlint.yml b/.github/workflows/commitlint.yml index 1d723746..766d57c2 100644 --- a/.github/workflows/commitlint.yml +++ b/.github/workflows/commitlint.yml @@ -15,7 +15,7 @@ jobs: - name: Setup Node.js uses: actions/setup-node@v3 with: - node-version: 20 + node-version: 24 - name: Install dependencies run: npm install diff --git a/package-lock.json b/package-lock.json index 3fc6c3b9..6e665262 100644 --- a/package-lock.json +++ b/package-lock.json @@ -32,7 +32,7 @@ "typescript": "^5.9.3" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "node_modules/@aashutoshrathi/word-wrap": { @@ -12368,7 +12368,7 @@ "version": "4.2.1", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "packages/client-metrics-web": { @@ -12379,7 +12379,7 @@ "aws-rum-web": "^1.25.0" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "packages/crash-handler": { @@ -12390,7 +12390,7 @@ "@dotcom-reliability-kit/log-error": "^5.1.6" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "packages/errors": { @@ -12398,7 +12398,7 @@ "version": "4.2.0", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "packages/eslint-config": { @@ -12409,7 +12409,7 @@ "@types/eslint": "^8.56.6" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "peerDependencies": { "eslint": ">=8.27.0" @@ -12430,7 +12430,7 @@ "undici": "^7.18.2" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "packages/log-error": { @@ -12447,7 +12447,7 @@ "@types/express": "^5.0.6" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "packages/logger": { @@ -12466,7 +12466,7 @@ "@types/lodash.clonedeep": "^4.5.9" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "peerDependencies": { "pino-pretty": ">=7.0.0 <11.0.0" @@ -12477,7 +12477,7 @@ "version": "1.1.0", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "packages/middleware-log-errors": { @@ -12492,7 +12492,7 @@ "express": "^5.2.1" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "packages/middleware-render-error-info": { @@ -12509,7 +12509,7 @@ "@types/express": "^5.0.6" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "packages/opentelemetry": { @@ -12533,7 +12533,7 @@ "express": "^5.2.1" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "packages/serialize-error": { @@ -12541,7 +12541,7 @@ "version": "4.2.0", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "packages/serialize-request": { @@ -12552,7 +12552,7 @@ "@types/express": "^5.0.6" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "resources/logos": { @@ -12568,7 +12568,7 @@ "@types/svgo": "^3.0.0" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" } }, "resources/splunk-dashboards": { diff --git a/package.json b/package.json index ad48bdd6..9a8d6ed9 100644 --- a/package.json +++ b/package.json @@ -45,7 +45,7 @@ "typescript": "^5.9.3" }, "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "volta": { "node": "22.13.0" diff --git a/packages/app-info/docs/migration.md b/packages/app-info/docs/migration.md index 122290e1..b2a4d93f 100644 --- a/packages/app-info/docs/migration.md +++ b/packages/app-info/docs/migration.md @@ -14,6 +14,8 @@ Emoji | Label | Meaning * [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported) * [Migrating from v3 to v4](#migrating-from-v3-to-v4) * [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported) +* [Migrating from v4 to v5](#migrating-from-v4-to-v5) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) ## Migrating from v1 to v2 @@ -35,3 +37,10 @@ Emoji | Label | Meaning ### Node.js 18 is no longer supported **:red_circle: Breaking:** this version drops support for Node.js v18. If your app is already using Node.js v20 or above then you can migrate with no code changes. + + +## Migrating from v4 to v5 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/app-info/package.json b/packages/app-info/package.json index 45beb8b3..7e126ce7 100644 --- a/packages/app-info/package.json +++ b/packages/app-info/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: app-info\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts" diff --git a/packages/client-metrics-web/README.md b/packages/client-metrics-web/README.md index 3c742384..ac1a6fba 100644 --- a/packages/client-metrics-web/README.md +++ b/packages/client-metrics-web/README.md @@ -34,6 +34,7 @@ A client for sending operational metrics events to [AWS CloudWatch RUM](https:// * [Usage (infrastructure)](#usage-infrastructure) * [Customer Products Client Metrics](#customer-products-client-metrics) * [Running your own infrastructure](#running-your-own-infrastructure) +* [Migrating](#migrating) * [Contributing](#contributing) * [License](#license) @@ -362,6 +363,12 @@ Resources: - errors ``` + +## Migrating + +Consult the [Migration Guide](./docs/migration.md) if you're trying to migrate to a later major version of this package. + + ## Contributing See the [central contributing guide for Reliability Kit](https://github.com/Financial-Times/dotcom-reliability-kit/blob/main/docs/contributing.md). diff --git a/packages/client-metrics-web/docs/migration.md b/packages/client-metrics-web/docs/migration.md new file mode 100644 index 00000000..6b169eeb --- /dev/null +++ b/packages/client-metrics-web/docs/migration.md @@ -0,0 +1,20 @@ + +# Migration guide for @dotcom-reliability-kit/client-metrics-web + +This document outlines how to migrate to the latest version of the Reliability Kit client-metrics-web package. Throughout this guide we use the following emoji and labels to indicate the level of change required: + +Emoji | Label | Meaning +----------------|:------------------|:------- +:red_circle: | Breaking | A breaking change which will likely require code or config changes to resolve +:orange_circle: | Possibly Breaking | A breaking change that is unlikely to require code changes but things outside of the code (e.g. logs) may have changed +:yellow_circle: | Deprecation | A deprecated feature which will require code changes in the future + +* [Migrating from v0 to v1](#migrating-from-v0-to-v1) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) + + +## Migrating from v0 to v1 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/client-metrics-web/package.json b/packages/client-metrics-web/package.json index 3dfc3e91..a0d054a5 100644 --- a/packages/client-metrics-web/package.json +++ b/packages/client-metrics-web/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: client-metrics-web\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts", diff --git a/packages/crash-handler/docs/migration.md b/packages/crash-handler/docs/migration.md index feaba3ac..f54f5268 100644 --- a/packages/crash-handler/docs/migration.md +++ b/packages/crash-handler/docs/migration.md @@ -17,6 +17,8 @@ Emoji | Label | Meaning * [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported) * [Migrating from v4 to v5](#migrating-from-v4-to-v5) * [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported) +* [Migrating from v5 to v6](#migrating-from-v5-to-v6) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) ## Migrating from v1 to v2 @@ -64,3 +66,10 @@ You can safely migrate to this version of Crash Handler if your app is either _n ### Node.js 18 is no longer supported **:red_circle: Breaking:** this version drops support for Node.js v18. If your app is already using Node.js v20 or above then you can migrate with no code changes. + + +## Migrating from v5 to v6 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/crash-handler/package.json b/packages/crash-handler/package.json index 7e256372..942e546e 100644 --- a/packages/crash-handler/package.json +++ b/packages/crash-handler/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: crash-handler\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts", diff --git a/packages/errors/docs/migration.md b/packages/errors/docs/migration.md index 8a5ad3e0..4029e5bb 100644 --- a/packages/errors/docs/migration.md +++ b/packages/errors/docs/migration.md @@ -14,6 +14,8 @@ Emoji | Label | Meaning * [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported) * [Migrating from v3 to v4](#migrating-from-v3-to-v4) * [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported) +* [Migrating from v4 to v5](#migrating-from-v4-to-v5) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) ## Migrating from v1 to v2 @@ -35,3 +37,10 @@ Emoji | Label | Meaning ### Node.js 18 is no longer supported **:red_circle: Breaking:** this version drops support for Node.js v18. If your app is already using Node.js v20 or above then you can migrate with no code changes. + + +## Migrating from v4 to v5 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/errors/package.json b/packages/errors/package.json index 4c538f59..b3f14bfd 100644 --- a/packages/errors/package.json +++ b/packages/errors/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: errors\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts" diff --git a/packages/eslint-config/docs/migration.md b/packages/eslint-config/docs/migration.md index ccfcbb9a..448d1ec9 100644 --- a/packages/eslint-config/docs/migration.md +++ b/packages/eslint-config/docs/migration.md @@ -14,6 +14,8 @@ Emoji | Label | Meaning * [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported) * [Migrating from v3 to v4](#migrating-from-v3-to-v4) * [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported) +* [Migrating from v4 to v5](#migrating-from-v4-to-v5) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) ## Migrating from v1 to v2 @@ -43,3 +45,10 @@ You may need to make changes to your code if these linting errors are found. ### Node.js 18 is no longer supported **:red_circle: Breaking:** this version drops support for Node.js v18. If your app is already using Node.js v20 or above then you can migrate with no code changes. + + +## Migrating from v4 to v5 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json index c02a50e1..583a9dc1 100644 --- a/packages/eslint-config/package.json +++ b/packages/eslint-config/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: eslint-config\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts", diff --git a/packages/fetch-error-handler/README.md b/packages/fetch-error-handler/README.md index 04b4f888..e8a12a88 100644 --- a/packages/fetch-error-handler/README.md +++ b/packages/fetch-error-handler/README.md @@ -19,6 +19,7 @@ Properly handle fetch errors and avoid a lot of boilerplate in your app. This mo * [Creating your own handler](#creating-your-own-handler) * [`createFetchErrorHandler` configuration options](#createfetcherrorhandler-configuration-options) * [`options.upstreamSystemCode`](#optionsupstreamsystemcode) +* [Migrating](#migrating) * [Contributing](#contributing) * [License](#license) @@ -219,6 +220,11 @@ const handleFetchErrors = createFetchErrorHandler({ When this is set, any errors thrown by `handleFetchErrors` will have a [`relatesToSystems` property](https://github.com/Financial-Times/dotcom-reliability-kit/tree/main/packages/errors#operationalerrorrelatestosystems) which includes the given system code. +## Migrating + +Consult the [Migration Guide](./docs/migration.md) if you're trying to migrate to a later major version of this package. + + ## Contributing See the [central contributing guide for Reliability Kit](https://github.com/Financial-Times/dotcom-reliability-kit/blob/main/docs/contributing.md). diff --git a/packages/fetch-error-handler/docs/migration.md b/packages/fetch-error-handler/docs/migration.md new file mode 100644 index 00000000..4a0d583a --- /dev/null +++ b/packages/fetch-error-handler/docs/migration.md @@ -0,0 +1,20 @@ + +# Migration guide for @dotcom-reliability-kit/fetch-error-handler + +This document outlines how to migrate to the latest version of the Reliability Kit fetch-error-handler package. Throughout this guide we use the following emoji and labels to indicate the level of change required: + +Emoji | Label | Meaning +----------------|:------------------|:------- +:red_circle: | Breaking | A breaking change which will likely require code or config changes to resolve +:orange_circle: | Possibly Breaking | A breaking change that is unlikely to require code changes but things outside of the code (e.g. logs) may have changed +:yellow_circle: | Deprecation | A deprecated feature which will require code changes in the future + +* [Migrating from v1 to v2](#migrating-from-v1-to-v2) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) + + +## Migrating from v1 to v2 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/fetch-error-handler/package.json b/packages/fetch-error-handler/package.json index 5f42b8aa..03f971ff 100644 --- a/packages/fetch-error-handler/package.json +++ b/packages/fetch-error-handler/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: fetch-error-handler\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts", diff --git a/packages/log-error/docs/migration.md b/packages/log-error/docs/migration.md index 438df63f..e2786247 100644 --- a/packages/log-error/docs/migration.md +++ b/packages/log-error/docs/migration.md @@ -17,6 +17,8 @@ Emoji | Label | Meaning * [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported) * [Migrating from v4 to v5](#migrating-from-v4-to-v5) * [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported) +* [Migrating from v5 to v6](#migrating-from-v5-to-v6) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) ## Migrating from v1 to v2 @@ -63,3 +65,10 @@ logHandledError({ ### Node.js 18 is no longer supported **:red_circle: Breaking:** this version drops support for Node.js v18. If your app is already using Node.js v20 or above then you can migrate with no code changes. + + +## Migrating from v5 to v6 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/log-error/package.json b/packages/log-error/package.json index 5babfee8..f4d24256 100644 --- a/packages/log-error/package.json +++ b/packages/log-error/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: log-error\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts", diff --git a/packages/logger/docs/migration.md b/packages/logger/docs/migration.md index c394f272..84c9752e 100644 --- a/packages/logger/docs/migration.md +++ b/packages/logger/docs/migration.md @@ -36,6 +36,8 @@ Emoji | Label | Meaning * [Log times are now ISO 8601 timestamps](#log-times-are-now-iso-8601-timestamps) * [Migrating from v3 to v4](#migrating-from-v3-to-v4) * [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported) +* [Migrating from v4 to v5](#migrating-from-v4-to-v5) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) ## Migrating from n-logger @@ -302,3 +304,10 @@ If neither of the above is true, this should be a safe update with no code chang ### Node.js 18 is no longer supported **:red_circle: Breaking:** this version drops support for Node.js v18. If your app is already using Node.js v20 or above then you can migrate with no code changes. + + +## Migrating from v4 to v5 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/logger/package.json b/packages/logger/package.json index d01286a4..1fa0425d 100644 --- a/packages/logger/package.json +++ b/packages/logger/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: logger\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts", diff --git a/packages/middleware-allow-request-methods/README.md b/packages/middleware-allow-request-methods/README.md index 386dc119..7b026c19 100644 --- a/packages/middleware-allow-request-methods/README.md +++ b/packages/middleware-allow-request-methods/README.md @@ -81,11 +81,18 @@ An array of HTTP methods that are allowed for the route. This must be an `Array` This option defaults to `[]`. + +## Migrating + +Consult the [Migration Guide](./docs/migration.md) if you're trying to migrate to a later major version of this package. + + ## Contributing See the [central contributing guide for Reliability Kit](https://github.com/Financial-Times/dotcom-reliability-kit/blob/main/docs/contributing.md). + ## License Licensed under the [MIT](https://github.com/Financial-Times/dotcom-reliability-kit/blob/main/LICENSE) license.
-Copyright © 2025, The Financial Times Ltd. \ No newline at end of file +Copyright © 2025, The Financial Times Ltd. diff --git a/packages/middleware-allow-request-methods/docs/migration.md b/packages/middleware-allow-request-methods/docs/migration.md new file mode 100644 index 00000000..d2d2a1a4 --- /dev/null +++ b/packages/middleware-allow-request-methods/docs/migration.md @@ -0,0 +1,20 @@ + +# Migration guide for @dotcom-reliability-kit/middleware-allow-request-methods + +This document outlines how to migrate to the latest version of the Reliability Kit middleware-allow-request-methods package. Throughout this guide we use the following emoji and labels to indicate the level of change required: + +Emoji | Label | Meaning +----------------|:------------------|:------- +:red_circle: | Breaking | A breaking change which will likely require code or config changes to resolve +:orange_circle: | Possibly Breaking | A breaking change that is unlikely to require code changes but things outside of the code (e.g. logs) may have changed +:yellow_circle: | Deprecation | A deprecated feature which will require code changes in the future + +* [Migrating from v1 to v2](#migrating-from-v1-to-v2) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) + + +## Migrating from v1 to v2 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/middleware-allow-request-methods/package.json b/packages/middleware-allow-request-methods/package.json index 531714f5..721fc222 100644 --- a/packages/middleware-allow-request-methods/package.json +++ b/packages/middleware-allow-request-methods/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: middleware-allow-request-methods\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts" diff --git a/packages/middleware-log-errors/docs/migration.md b/packages/middleware-log-errors/docs/migration.md index 7d93c4b3..e4b10703 100644 --- a/packages/middleware-log-errors/docs/migration.md +++ b/packages/middleware-log-errors/docs/migration.md @@ -17,6 +17,8 @@ Emoji | Label | Meaning * [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported) * [Migrating from v4 to v5](#migrating-from-v4-to-v5) * [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported) +* [Migrating from v5 to v6](#migrating-from-v5-to-v6) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) ## Migrating from v1 to v2 @@ -66,3 +68,10 @@ You can safely migrate to this version of the error logging middleware if your a ### Node.js 18 is no longer supported **:red_circle: Breaking:** this version drops support for Node.js v18. If your app is already using Node.js v20 or above then you can migrate with no code changes. + + +## Migrating from v5 to v6 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/middleware-log-errors/package.json b/packages/middleware-log-errors/package.json index 4f0b3d6e..853e4bfa 100644 --- a/packages/middleware-log-errors/package.json +++ b/packages/middleware-log-errors/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: middleware-log-errors\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts", diff --git a/packages/middleware-render-error-info/docs/migration.md b/packages/middleware-render-error-info/docs/migration.md index 3e2a8d54..f3d6cec0 100644 --- a/packages/middleware-render-error-info/docs/migration.md +++ b/packages/middleware-render-error-info/docs/migration.md @@ -19,6 +19,8 @@ Emoji | Label | Meaning * [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported) * [Migrating from v5 to v6](#migrating-from-v5-to-v6) * [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported) +* [Migrating from v6 to v7](#migrating-from-v6-to-v7) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) ## Migrating from v1 to v2 @@ -62,3 +64,10 @@ You can safely migrate to this version of the error logging middleware if your a ### Node.js 18 is no longer supported **:red_circle: Breaking:** this version drops support for Node.js v18. If your app is already using Node.js v20 or above then you can migrate with no code changes. + + +## Migrating from v6 to v7 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/middleware-render-error-info/package.json b/packages/middleware-render-error-info/package.json index bcc7864f..aa5d3d62 100644 --- a/packages/middleware-render-error-info/package.json +++ b/packages/middleware-render-error-info/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: middleware-render-error-info\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts", diff --git a/packages/opentelemetry/docs/migration.md b/packages/opentelemetry/docs/migration.md index 1ba0a06b..12b899c3 100644 --- a/packages/opentelemetry/docs/migration.md +++ b/packages/opentelemetry/docs/migration.md @@ -13,6 +13,8 @@ Emoji | Label | Meaning * [JavaScript API changes](#javascript-api-changes) * [Migrating from v2 to v3](#migrating-from-v2-to-v3) * [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported) +* [Migrating from v3 to v4](#migrating-from-v3-to-v4) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) ## Migrating from v1 to v2 @@ -40,3 +42,10 @@ If you're using the `--require` method or importing `@dotcom-reliability-kit/ope ### Node.js 18 is no longer supported **:red_circle: Breaking:** this version drops support for Node.js v18. If your app is already using Node.js v20 or above then you can migrate with no code changes. + + +## Migrating from v3 to v4 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/opentelemetry/package.json b/packages/opentelemetry/package.json index 1cda1927..2eb9320a 100644 --- a/packages/opentelemetry/package.json +++ b/packages/opentelemetry/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: opentelemetry\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts", diff --git a/packages/serialize-error/docs/migration.md b/packages/serialize-error/docs/migration.md index 5aac8cab..93870b49 100644 --- a/packages/serialize-error/docs/migration.md +++ b/packages/serialize-error/docs/migration.md @@ -14,6 +14,8 @@ Emoji | Label | Meaning * [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported) * [Migrating from v3 to v4](#migrating-from-v3-to-v4) * [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported) +* [Migrating from v4 to v5](#migrating-from-v4-to-v5) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) ## Migrating from v1 to v2 @@ -35,3 +37,10 @@ Emoji | Label | Meaning ### Node.js 18 is no longer supported **:red_circle: Breaking:** this version drops support for Node.js v18. If your app is already using Node.js v20 or above then you can migrate with no code changes. + + +## Migrating from v4 to v5 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/serialize-error/package.json b/packages/serialize-error/package.json index ea7c10af..01653118 100644 --- a/packages/serialize-error/package.json +++ b/packages/serialize-error/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: serialize-error\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts" diff --git a/packages/serialize-request/docs/migration.md b/packages/serialize-request/docs/migration.md index c16b8fab..2e8f0fb1 100644 --- a/packages/serialize-request/docs/migration.md +++ b/packages/serialize-request/docs/migration.md @@ -14,6 +14,8 @@ Emoji | Label | Meaning * [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported) * [Migrating from v3 to v4](#migrating-from-v3-to-v4) * [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported) +* [Migrating from v4 to v5](#migrating-from-v4-to-v5) + * [Node.js 20 is no longer supported](#nodejs-20-is-no-longer-supported) ## Migrating from v1 to v2 @@ -35,3 +37,10 @@ Emoji | Label | Meaning ### Node.js 18 is no longer supported **:red_circle: Breaking:** this version drops support for Node.js v18. If your app is already using Node.js v20 or above then you can migrate with no code changes. + + +## Migrating from v4 to v5 + +### Node.js 20 is no longer supported + +**:red_circle: Breaking:** this version drops support for Node.js v20. If your app is already using Node.js v22 then you may be able to migrate without code changes. diff --git a/packages/serialize-request/package.json b/packages/serialize-request/package.json index c8315698..71d842ae 100644 --- a/packages/serialize-request/package.json +++ b/packages/serialize-request/package.json @@ -11,7 +11,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues?q=label:\"package: serialize-request\"", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "main": "lib/index.js", "types": "types/index.d.ts", diff --git a/resources/logos/package.json b/resources/logos/package.json index 054af8ad..19d87cbe 100644 --- a/resources/logos/package.json +++ b/resources/logos/package.json @@ -12,7 +12,7 @@ "bugs": "https://github.com/Financial-Times/dotcom-reliability-kit/issues", "license": "MIT", "engines": { - "node": "20.x || 22.x || 24.x" + "node": "22.x || 24.x" }, "scripts": { "build": "./scripts/build.js"