From e55827fc766b179cb38a6793ebc178e8d289af63 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Vanvelthem?= Date: Sat, 6 Jan 2024 14:53:31 +0100 Subject: [PATCH] docs: mention upgrade notes --- docs/src/pages/exception/index.mdx | 10 ++++++++++ packages/exception/README.md | 11 ++++++++++- packages/exception/package.json | 1 + 3 files changed, 21 insertions(+), 1 deletion(-) diff --git a/docs/src/pages/exception/index.mdx b/docs/src/pages/exception/index.mdx index 2119d55ca..51acd257f 100644 --- a/docs/src/pages/exception/index.mdx +++ b/docs/src/pages/exception/index.mdx @@ -516,3 +516,13 @@ The export fields and the builds are checked on the CI with [are-the-types-wrong This library targets typescript 5+ with descriptions (see [the generated api docs](https://github.com/belgattitude/httpx/tree/main/packages/exception/docs/api)). + +## Upgrade + +> Refer to the [UPGRADE.md](https://github.com/belgattitude/httpx/blob/main/packages/exception/UPGRADE.md) for detailed information. + +| Version | Comment | +|---------|---------------------------------------------------------------------| +| 3.x | Serializer functions don't include stack by default | +| 2.x | Node 18.x, modern browsers (see how to [transpile](#compatibility)) | + diff --git a/packages/exception/README.md b/packages/exception/README.md index 66bb5d520..78957753c 100644 --- a/packages/exception/README.md +++ b/packages/exception/README.md @@ -539,9 +539,18 @@ The export fields and the builds are checked on the CI with [are-the-types-wrong This library targets typescript 5+ with descriptions (see [the generated api docs](https://github.com/belgattitude/httpx/tree/main/packages/exception/docs/api)). +## Upgrade + +> Refer to the [UPGRADE.md](https://github.com/belgattitude/httpx/blob/main/packages/exception/UPGRADE.md) for detailed information. + +| Version | Comment | +| ------- | ------------------------------------------------------------------- | +| 3.x | Serializer functions don't include stack by default | +| 2.x | Node 18.x, modern browsers (see how to [transpile](#compatibility)) | + ## Support -Don't hesitate and open [an issue](https://github.com/belgattitude/httpx/issues). +Open [an issue on github](https://github.com/belgattitude/httpx/issues). ## Contributors diff --git a/packages/exception/package.json b/packages/exception/package.json index a4e08aa8e..e56d17988 100644 --- a/packages/exception/package.json +++ b/packages/exception/package.json @@ -83,6 +83,7 @@ "files": [ "dist", "README.md", + "UPGRADE.md", "package.json", "LICENSE", "CHANGELOG.md"