Skip to content

Commit 12dd501

Browse files
committed
docs: add migration guides for new major versions
1 parent 16883d0 commit 12dd501

File tree

11 files changed

+124
-25
lines changed

11 files changed

+124
-25
lines changed

packages/app-info/docs/migration.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Emoji | Label | Meaning
1212
* [Node.js 14 is no longer supported](#nodejs-14-is-no-longer-supported)
1313
* [Migrating from v2 to v3](#migrating-from-v2-to-v3)
1414
* [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported)
15+
* [Migrating from v3 to v4](#migrating-from-v3-to-v4)
16+
* [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported)
1517

1618

1719
## Migrating from v1 to v2
@@ -26,3 +28,10 @@ Emoji | Label | Meaning
2628
### Node.js 16 is no longer supported
2729

2830
**:red_circle: Breaking:** this version drops support for Node.js v16. If your app is already using Node.js v18 or above then you can migrate with no code changes.
31+
32+
33+
## Migrating from v3 to v4
34+
35+
### Node.js 18 is no longer supported
36+
37+
**: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.

packages/crash-handler/docs/migration.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Emoji | Label | Meaning
1515
* [Remove Sentry workarounds](#remove-sentry-workarounds)
1616
* [Migrating from v3 to v4](#migrating-from-v3-to-v4)
1717
* [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported)
18+
* [Migrating from v4 to v5](#migrating-from-v4-to-v5)
19+
* [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported)
1820

1921

2022
## Migrating from v1 to v2
@@ -55,3 +57,10 @@ You can safely migrate to this version of Crash Handler if your app is either _n
5557
### Node.js 16 is no longer supported
5658

5759
**:red_circle: Breaking:** this version drops support for Node.js v16. If your app is already using Node.js v18 or above then you can migrate with no code changes.
60+
61+
62+
## Migrating from v4 to v5
63+
64+
### Node.js 18 is no longer supported
65+
66+
**: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.

packages/errors/docs/migration.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Emoji | Label | Meaning
1212
* [Node.js 14 is no longer supported](#nodejs-14-is-no-longer-supported)
1313
* [Migrating from v2 to v3](#migrating-from-v2-to-v3)
1414
* [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported)
15+
* [Migrating from v3 to v4](#migrating-from-v3-to-v4)
16+
* [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported)
1517

1618

1719
## Migrating from v1 to v2
@@ -26,3 +28,10 @@ Emoji | Label | Meaning
2628
### Node.js 16 is no longer supported
2729

2830
**:red_circle: Breaking:** this version drops support for Node.js v16. If your app is already using Node.js v18 or above then you can migrate with no code changes.
31+
32+
33+
## Migrating from v3 to v4
34+
35+
### Node.js 18 is no longer supported
36+
37+
**: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.

packages/eslint-config/docs/migration.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Emoji | Label | Meaning
1212
* [Additional default ESLint rules added (v2)](#additional-default-eslint-rules-added-v2)
1313
* [Migrating from v2 to v3](#migrating-from-v2-to-v3)
1414
* [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported)
15+
* [Migrating from v3 to v4](#migrating-from-v3-to-v4)
16+
* [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported)
1517

1618

1719
## Migrating from v1 to v2
@@ -34,3 +36,10 @@ You may need to make changes to your code if these linting errors are found.
3436
### Node.js 16 is no longer supported
3537

3638
**:red_circle: Breaking:** this version drops support for Node.js v16. If your app is already using Node.js v18 or above then you can migrate with no code changes.
39+
40+
41+
## Migrating from v3 to v4
42+
43+
### Node.js 18 is no longer supported
44+
45+
**: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.

packages/log-error/docs/migration.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Emoji | Label | Meaning
1515
* [Unhandled errors now have a level of fatal](#unhandled-errors-now-have-a-level-of-fatal)
1616
* [Migrating from v3 to v4](#migrating-from-v3-to-v4)
1717
* [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported)
18+
* [Migrating from v4 to v5](#migrating-from-v4-to-v5)
19+
* [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported)
1820

1921

2022
## Migrating from v1 to v2
@@ -54,3 +56,10 @@ logHandledError({
5456
### Node.js 16 is no longer supported
5557

5658
**:red_circle: Breaking:** this version drops support for Node.js v16. If your app is already using Node.js v18 or above then you can migrate with no code changes.
59+
60+
61+
## Migrating from v4 to v5
62+
63+
### Node.js 18 is no longer supported
64+
65+
**: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.

packages/logger/docs/migration.md

Lines changed: 34 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -9,31 +9,33 @@ Emoji | Label | Meaning
99
: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
1010
:yellow_circle: | Deprecation | A deprecated feature which will require code changes in the future
1111

12-
* [Migrating from n-logger](#migrating-from-n-logger)
13-
* [Where logs get sent](#n-logger-where-logs-get-sent)
14-
* [Error serialization changes](#n-logger-error-serialization-changes)
15-
* [Log timestamps](#n-logger-log-timestamps)
16-
* [Log level changes](#n-logger-log-level-changes)
17-
* [Logger method changes](#n-logger-method-changes)
18-
* [Environment variable changes](#n-logger-environment-variable-changes)
19-
* [Proxy incompatibility](#n-logger-proxy-incompatibility)
20-
* [Migrating from n-mask-logger](#migrating-from-n-mask-logger)
21-
* [API changes](#n-mask-logger-api-changes)
22-
* [where logs get sent](#n-mask-logger-where-logs-get-sent)
23-
* [log timestamps](#n-mask-logger-log-timestamps)
24-
* [method changes](#n-mask-logger-method-changes)
25-
* [environment variable changes](#n-mask-logger-environment-variable-changes)
26-
* [Migrating from n-serverless-logger](#migrating-from-n-serverless-logger)
27-
* [Where logs get sent](#n-serverless-logger-where-logs-get-sent)
28-
* [Error serialization changes](#n-serverless-logger-error-serialization-changes)
29-
* [Logger property changes](#n-serverless-logger-property-changes)
30-
* [Logger method changes](#n-serverless-logger-method-changes)
31-
* [Environment variable changes](#n-serverless-logger-environment-variable-changes)
32-
* [Migrating from v1 to v2](#migrating-from-v1-to-v2)
33-
* [Node.js 14 is no longer supported](#nodejs-14-is-no-longer-supported)
34-
* [Migrating from v2 to v3](#migrating-from-v2-to-v3)
35-
* [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported)
36-
* [Log times are now ISO 8601 timestamps](#log-times-are-now-iso-8601-timestamps)
12+
* [Migrating from n-logger](#migrating-from-n-logger)
13+
* [n-logger: where logs get sent](#n-logger-where-logs-get-sent)
14+
* [n-logger: error serialization changes](#n-logger-error-serialization-changes)
15+
* [n-logger: log timestamps](#n-logger-log-timestamps)
16+
* [n-logger: log level changes](#n-logger-log-level-changes)
17+
* [n-logger: method changes](#n-logger-method-changes)
18+
* [n-logger: environment variable changes](#n-logger-environment-variable-changes)
19+
* [n-logger: proxy incompatibility](#n-logger-proxy-incompatibility)
20+
* [Migrating from n-mask-logger](#migrating-from-n-mask-logger)
21+
* [n-mask-logger: API changes](#n-mask-logger-api-changes)
22+
* [n-mask-logger: where logs get sent](#n-mask-logger-where-logs-get-sent)
23+
* [n-mask-logger: log timestamps](#n-mask-logger-log-timestamps)
24+
* [n-mask-logger: method changes](#n-mask-logger-method-changes)
25+
* [n-mask-logger: environment variable changes](#n-mask-logger-environment-variable-changes)
26+
* [Migrating from n-serverless-logger](#migrating-from-n-serverless-logger)
27+
* [n-serverless-logger: where logs get sent](#n-serverless-logger-where-logs-get-sent)
28+
* [n-serverless-logger: error serialization changes](#n-serverless-logger-error-serialization-changes)
29+
* [n-serverless-logger: property changes](#n-serverless-logger-property-changes)
30+
* [n-serverless-logger: method changes](#n-serverless-logger-method-changes)
31+
* [n-serverless-logger: environment variable changes](#n-serverless-logger-environment-variable-changes)
32+
* [Migrating from v1 to v2](#migrating-from-v1-to-v2)
33+
* [Node.js 14 is no longer supported](#nodejs-14-is-no-longer-supported)
34+
* [Migrating from v2 to v3](#migrating-from-v2-to-v3)
35+
* [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported)
36+
* [Log times are now ISO 8601 timestamps](#log-times-are-now-iso-8601-timestamps)
37+
* [Migrating from v3 to v4](#migrating-from-v3-to-v4)
38+
* [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported)
3739

3840

3941
## Migrating from n-logger
@@ -293,3 +295,10 @@ The following environment variables have been deprecated.
293295
2. If you're using the `withTimestamps` or `useIsoTimeFormat` options with TypeScript, because these options have now been removed from the code and the type definitions.
294296

295297
If neither of the above is true, this should be a safe update with no code changes.
298+
299+
300+
## Migrating from v3 to v4
301+
302+
### Node.js 18 is no longer supported
303+
304+
**: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.

packages/middleware-log-errors/docs/migration.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ Emoji | Label | Meaning
1515
* [Remove Sentry workarounds](#remove-sentry-workarounds)
1616
* [Migrating from v3 to v4](#migrating-from-v3-to-v4)
1717
* [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported)
18+
* [Migrating from v4 to v5](#migrating-from-v4-to-v5)
19+
* [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported)
1820

1921

2022
## Migrating from v1 to v2
@@ -57,3 +59,10 @@ You can safely migrate to this version of the error logging middleware if your a
5759
### Node.js 16 is no longer supported
5860

5961
**:red_circle: Breaking:** this version drops support for Node.js v16. If your app is already using Node.js v18 or above then you can migrate with no code changes.
62+
63+
64+
## Migrating from v4 to v5
65+
66+
### Node.js 18 is no longer supported
67+
68+
**: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.

packages/middleware-render-error-info/docs/migration.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Emoji | Label | Meaning
1717
* [Errors are now rendered in production](#errors-are-now-rendered-in-production)
1818
* [Migrating from v4 to v5](#migrating-from-v4-to-v5)
1919
* [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported)
20+
* [Migrating from v5 to v6](#migrating-from-v5-to-v6)
21+
* [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported)
2022

2123

2224
## Migrating from v1 to v2
@@ -53,3 +55,10 @@ You can safely migrate to this version of the error logging middleware if your a
5355
### Node.js 16 is no longer supported
5456

5557
**:red_circle: Breaking:** this version drops support for Node.js v16. If your app is already using Node.js v18 or above then you can migrate with no code changes.
58+
59+
60+
## Migrating from v5 to v6
61+
62+
### Node.js 18 is no longer supported
63+
64+
**: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.

packages/opentelemetry/docs/migration.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ Emoji | Label | Meaning
1111

1212
* [Migrating from v1 to v2](#migrating-from-v1-to-v2)
1313
* [JavaScript API changes](#javascript-api-changes)
14+
* [Migrating from v2 to v3](#migrating-from-v2-to-v3)
15+
* [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported)
1416

1517

1618
## Migrating from v1 to v2
@@ -31,3 +33,10 @@ Emoji | Label | Meaning
3133
```
3234

3335
If you're using the `--require` method or importing `@dotcom-reliability-kit/opentelemetry/setup` then this is not a breaking change.
36+
37+
38+
## Migrating from v2 to v3
39+
40+
### Node.js 18 is no longer supported
41+
42+
**: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.

packages/serialize-error/docs/migration.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Emoji | Label | Meaning
1212
* [Node.js 14 is no longer supported](#nodejs-14-is-no-longer-supported)
1313
* [Migrating from v2 to v3](#migrating-from-v2-to-v3)
1414
* [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported)
15+
* [Migrating from v3 to v4](#migrating-from-v3-to-v4)
16+
* [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported)
1517

1618

1719
## Migrating from v1 to v2
@@ -26,3 +28,10 @@ Emoji | Label | Meaning
2628
### Node.js 16 is no longer supported
2729

2830
**:red_circle: Breaking:** this version drops support for Node.js v16. If your app is already using Node.js v18 or above then you can migrate with no code changes.
31+
32+
33+
## Migrating from v3 to v4
34+
35+
### Node.js 18 is no longer supported
36+
37+
**: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.

packages/serialize-request/docs/migration.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ Emoji | Label | Meaning
1212
* [Node.js 14 is no longer supported](#nodejs-14-is-no-longer-supported)
1313
* [Migrating from v2 to v3](#migrating-from-v2-to-v3)
1414
* [Node.js 16 is no longer supported](#nodejs-16-is-no-longer-supported)
15+
* [Migrating from v3 to v4](#migrating-from-v3-to-v4)
16+
* [Node.js 18 is no longer supported](#nodejs-18-is-no-longer-supported)
1517

1618

1719
## Migrating from v1 to v2
@@ -26,3 +28,10 @@ Emoji | Label | Meaning
2628
### Node.js 16 is no longer supported
2729

2830
**:red_circle: Breaking:** this version drops support for Node.js v16. If your app is already using Node.js v18 or above then you can migrate with no code changes.
31+
32+
33+
## Migrating from v3 to v4
34+
35+
### Node.js 18 is no longer supported
36+
37+
**: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.

0 commit comments

Comments
 (0)