Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 11 additions & 11 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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:
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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:
Expand All @@ -261,12 +261,12 @@ 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 >>
context: next-nightly-build
name: test-v<< matrix.node-version >>
matrix:
parameters:
node-version: [ "24.0", "22.13", "20.18" ]
node-version: [ "24.0", "22.13" ]
2 changes: 1 addition & 1 deletion .github/workflows/commitlint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
32 changes: 16 additions & 16 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
9 changes: 9 additions & 0 deletions packages/app-info/docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
2 changes: 1 addition & 1 deletion packages/app-info/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
7 changes: 7 additions & 0 deletions packages/client-metrics-web/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down Expand Up @@ -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).
Expand Down
20 changes: 20 additions & 0 deletions packages/client-metrics-web/docs/migration.md
Original file line number Diff line number Diff line change
@@ -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.
2 changes: 1 addition & 1 deletion packages/client-metrics-web/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
9 changes: 9 additions & 0 deletions packages/crash-handler/docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
2 changes: 1 addition & 1 deletion packages/crash-handler/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
9 changes: 9 additions & 0 deletions packages/errors/docs/migration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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.
2 changes: 1 addition & 1 deletion packages/errors/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
Loading