From 0d1f7bc5124278c289f34e9169b41bd69e9c777d Mon Sep 17 00:00:00 2001 From: Ayan Khan Date: Tue, 2 Jan 2024 14:26:56 -0500 Subject: [PATCH 1/4] update MIGRATING.md and README.md in preparation for v5 release --- MIGRATING.md | 8 ++++++++ README.md | 15 ++++++++------- 2 files changed, 16 insertions(+), 7 deletions(-) diff --git a/MIGRATING.md b/MIGRATING.md index 649037d39fa..4da35fde2ad 100644 --- a/MIGRATING.md +++ b/MIGRATING.md @@ -4,6 +4,14 @@ This guide describes the steps to upgrade dd-trace from a major version to the next. If you are having any issues related to migrating, please feel free to open an issue or contact our [support](https://www.datadoghq.com/support/) team. +## 4.0 to 5.0 + +### Node 16 is no longer supported + +Node.js 16 has reached EOL in September 2023 and is no longer supported. Generally +speaking, we highly recommend always keeping Node.js up to date regardless of +our support policy. + ## 3.0 to 4.0 ### Node 14 is no longer supported diff --git a/README.md b/README.md index 341283a71ca..5621a531ad7 100644 --- a/README.md +++ b/README.md @@ -28,24 +28,25 @@ Most of the documentation for `dd-trace` is available on these webpages: | [`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 | | [`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 | | [`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 | -| [`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 | +| [`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` | **Current** | 2023-05-12 | 2025-01-02 | +| [`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-02 | Unknown | -We currently maintain two release lines, namely `v3` and `v4`. -Features and bug fixes that are merged are released to the `v4` line and, if appropriate, also the `v3` line. +We currently maintain three release lines, namely `v5`, `v4` and `v3`. +Features and bug fixes that are merged are released to the `v3` line and, if appropriate, also the `v4` & `v3` line. -For any new projects it is recommended to use the `v4` release line: +For any new projects it is recommended to use the `v5` release line: ```sh $ npm install dd-trace $ yarn add dd-trace ``` -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. +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. This is done by specifying the version when installing the package. ```sh -$ npm install dd-trace@3 -$ yarn add dd-trace@3 +$ npm install dd-trace@4 +$ yarn add dd-trace@4 ``` 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. From a08aa28927894612673d0b85cfa68e627875633c Mon Sep 17 00:00:00 2001 From: Ayan Khan Date: Tue, 2 Jan 2024 14:32:15 -0500 Subject: [PATCH 2/4] fix README.md --- README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 5621a531ad7..452710a3a3e 100644 --- a/README.md +++ b/README.md @@ -28,11 +28,11 @@ Most of the documentation for `dd-trace` is available on these webpages: | [`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 | | [`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 | | [`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 | -| [`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` | **Current** | 2023-05-12 | 2025-01-02 | +| [`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-02 | | [`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-02 | Unknown | We currently maintain three release lines, namely `v5`, `v4` and `v3`. -Features and bug fixes that are merged are released to the `v3` line and, if appropriate, also the `v4` & `v3` line. +Features and bug fixes that are merged are released to the `v5` line and, if appropriate, also the `v4` & `v3` line. For any new projects it is recommended to use the `v5` release line: From 858dcc4b6eb39b102a058f1401b7e05ff943bbe2 Mon Sep 17 00:00:00 2001 From: Ayan Khan Date: Thu, 11 Jan 2024 09:34:28 -0500 Subject: [PATCH 3/4] update MIGRATING.md --- MIGRATING.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/MIGRATING.md b/MIGRATING.md index 4da35fde2ad..39160fce6c0 100644 --- a/MIGRATING.md +++ b/MIGRATING.md @@ -12,6 +12,13 @@ Node.js 16 has reached EOL in September 2023 and is no longer supported. General speaking, we highly recommend always keeping Node.js up to date regardless of our support policy. +### Update `trace` TypeScript declaration + +The TypeScript declaration for `trace` has been updated to enforce +that calls to `tracer.trace(name, fn)` must receive a function which takes at least +the span object. Previously the span was technically optional when it should not have +been as the span must be handled. + ## 3.0 to 4.0 ### Node 14 is no longer supported From e0d2a564f30b8e3bab5715f675e74b71d96ee74a Mon Sep 17 00:00:00 2001 From: Ayan Khan Date: Thu, 11 Jan 2024 11:42:04 -0500 Subject: [PATCH 4/4] update readme --- README.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 452710a3a3e..854107f8860 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,8 @@ # `dd-trace`: Node.js APM Tracer Library -[![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) -[![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) +[![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) +[![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) +[![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) [![codecov](https://codecov.io/gh/DataDog/dd-trace-js/branch/master/graph/badge.svg)](https://codecov.io/gh/DataDog/dd-trace-js) Bits the dog JavaScript @@ -28,8 +29,8 @@ Most of the documentation for `dd-trace` is available on these webpages: | [`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 | | [`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 | | [`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 | -| [`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-02 | -| [`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-02 | Unknown | +| [`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 | +| [`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 | We currently maintain three release lines, namely `v5`, `v4` and `v3`. Features and bug fixes that are merged are released to the `v5` line and, if appropriate, also the `v4` & `v3` line.