From 6795e33e7838a2ab342876b713a4f0021b54b341 Mon Sep 17 00:00:00 2001 From: Camila Belo Date: Mon, 19 Aug 2024 09:43:37 +0200 Subject: [PATCH] docs: mark backend-common as deprecated Signed-off-by: Camila Belo --- .changeset/famous-cougars-walk.md | 5 +++++ packages/backend-common/README.md | 3 +++ packages/backend-common/src/index.ts | 3 +++ 3 files changed, 11 insertions(+) create mode 100644 .changeset/famous-cougars-walk.md diff --git a/.changeset/famous-cougars-walk.md b/.changeset/famous-cougars-walk.md new file mode 100644 index 0000000000..465b03f86d --- /dev/null +++ b/.changeset/famous-cougars-walk.md @@ -0,0 +1,5 @@ +--- +'@backstage/backend-common': patch +--- + +This package is marked as `deprecated` and will be removed in a near future, please follow the deprecated instructions for the exports you still use. diff --git a/packages/backend-common/README.md b/packages/backend-common/README.md index 71a15bfb5a..e9f2f43e83 100644 --- a/packages/backend-common/README.md +++ b/packages/backend-common/README.md @@ -1,5 +1,8 @@ # @backstage/backend-common +> [!CAUTION] +> This package is deprecated and will be removed in a near future, so please follow the deprecated instructions for the exports you still use. + Common functionality library for Backstage backends, implementing logging, error handling and similar. diff --git a/packages/backend-common/src/index.ts b/packages/backend-common/src/index.ts index ad5621b5a9..e08bef3048 100644 --- a/packages/backend-common/src/index.ts +++ b/packages/backend-common/src/index.ts @@ -17,6 +17,9 @@ /** * Common functionality library for Backstage backends * + * @remarks + * This package is deprecated and will be removed in a near future, so please follow the deprecated instructions for the exports you still use. + * * @packageDocumentation */