Skip to content

Commit 1c41eb4

Browse files
khanayan123szegedi
authored andcommitted
update MIGRATING.md and README.md in preparation for v5 release (#3918)
* update MIGRATING.md and README.md in preparation for v5 release
1 parent 7fc91f4 commit 1c41eb4

File tree

2 files changed

+26
-9
lines changed

2 files changed

+26
-9
lines changed

MIGRATING.md

+15
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,21 @@ This guide describes the steps to upgrade dd-trace from a major version to the
44
next. If you are having any issues related to migrating, please feel free to
55
open an issue or contact our [support](https://www.datadoghq.com/support/) team.
66

7+
## 4.0 to 5.0
8+
9+
### Node 16 is no longer supported
10+
11+
Node.js 16 has reached EOL in September 2023 and is no longer supported. Generally
12+
speaking, we highly recommend always keeping Node.js up to date regardless of
13+
our support policy.
14+
15+
### Update `trace<T>` TypeScript declaration
16+
17+
The TypeScript declaration for `trace<T>` has been updated to enforce
18+
that calls to `tracer.trace(name, fn)` must receive a function which takes at least
19+
the span object. Previously the span was technically optional when it should not have
20+
been as the span must be handled.
21+
722
## 3.0 to 4.0
823

924
### Node 14 is no longer supported

README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
11
# `dd-trace`: Node.js APM Tracer Library
22

3-
[![npm v4](https://img.shields.io/npm/v/dd-trace/latest?color=blue&label=dd-trace%40v4&logo=npm)](https://www.npmjs.com/package/dd-trace)
4-
[![npm v3](https://img.shields.io/npm/v/dd-trace/latest-node14?color=blue&label=dd-trace%40v3&logo=npm)](https://www.npmjs.com/package/dd-trace/v/latest-node12)
3+
[![npm v5](https://img.shields.io/npm/v/dd-trace/latest?color=blue&label=dd-trace%40v4&logo=npm)](https://www.npmjs.com/package/dd-trace)
4+
[![npm v4](https://img.shields.io/npm/v/dd-trace/latest-node16?color=blue&label=dd-trace%40v4&logo=npm)](https://www.npmjs.com/package/dd-trace/v/latest-node16)
5+
[![npm v3](https://img.shields.io/npm/v/dd-trace/latest-node14?color=blue&label=dd-trace%40v3&logo=npm)](https://www.npmjs.com/package/dd-trace/v/latest-node14)
56
[![codecov](https://codecov.io/gh/DataDog/dd-trace-js/branch/master/graph/badge.svg)](https://codecov.io/gh/DataDog/dd-trace-js)
67

78
<img align="right" src="https://user-images.githubusercontent.com/551402/208212084-1d0c07e2-4135-4c61-b2da-8f2fddbc66ed.png" alt="Bits the dog JavaScript" width="200px"/>
@@ -28,24 +29,25 @@ Most of the documentation for `dd-trace` is available on these webpages:
2829
| [`v1`](https://github.com/DataDog/dd-trace-js/tree/v1.x) | ![npm v1](https://img.shields.io/npm/v/dd-trace/legacy-v1?color=white&label=%20&style=flat-square) | `>= v12` | **End of Life** | 2021-07-13 | 2022-02-25 |
2930
| [`v2`](https://github.com/DataDog/dd-trace-js/tree/v2.x) | ![npm v2](https://img.shields.io/npm/v/dd-trace/latest-node12?color=white&label=%20&style=flat-square) | `>= v12` | **End of Life** | 2022-01-28 | 2023-08-15 |
3031
| [`v3`](https://github.com/DataDog/dd-trace-js/tree/v3.x) | ![npm v3](https://img.shields.io/npm/v/dd-trace/latest-node14?color=white&label=%20&style=flat-square) | `>= v14` | **Maintenance** | 2022-08-15 | 2024-05-15 |
31-
| [`v4`](https://github.com/DataDog/dd-trace-js/tree/v4.x) | ![npm v4](https://img.shields.io/npm/v/dd-trace/latest?color=white&label=%20&style=flat-square) | `>= v16` | **Current** | 2023-05-12 | Unknown |
32+
| [`v4`](https://github.com/DataDog/dd-trace-js/tree/v4.x) | ![npm v4](https://img.shields.io/npm/v/dd-trace/latest-node16?color=white&label=%20&style=flat-square) | `>= v16` | **Maintenance** | 2023-05-12 | 2025-01-11 |
33+
| [`v5`](https://github.com/DataDog/dd-trace-js/tree/v5.x) | ![npm v5](https://img.shields.io/npm/v/dd-trace/latest?color=white&label=%20&style=flat-square) | `>= v18` | **Current** | 2024-01-11 | Unknown |
3234

33-
We currently maintain two release lines, namely `v3` and `v4`.
34-
Features and bug fixes that are merged are released to the `v4` line and, if appropriate, also the `v3` line.
35+
We currently maintain three release lines, namely `v5`, `v4` and `v3`.
36+
Features and bug fixes that are merged are released to the `v5` line and, if appropriate, also the `v4` & `v3` line.
3537

36-
For any new projects it is recommended to use the `v4` release line:
38+
For any new projects it is recommended to use the `v5` release line:
3739

3840
```sh
3941
$ npm install dd-trace
4042
$ yarn add dd-trace
4143
```
4244

43-
However, existing projects that already use the `v3` release line, or projects that need to support EOL versions of Node.js, may continue to use these release lines.
45+
However, existing projects that already use the `v4` & `v3` release line, or projects that need to support EOL versions of Node.js, may continue to use these release lines.
4446
This is done by specifying the version when installing the package.
4547

4648
```sh
47-
$ npm install dd-trace@3
48-
$ yarn add dd-trace@3
49+
$ npm install dd-trace@4
50+
$ yarn add dd-trace@4
4951
```
5052

5153
Any backwards-breaking functionality that is introduced into the library will result in an increase of the major version of the library and therefore a new release line.

0 commit comments

Comments
 (0)