From 37bd87012867a4061b279c78b51ced96a0a8f3ea Mon Sep 17 00:00:00 2001 From: Andre Wanlin <67169551+awanlin@users.noreply.github.com> Date: Sun, 1 Dec 2024 12:03:11 -0600 Subject: [PATCH] code-coverage - Deprecated legacy backend (#2046) Signed-off-by: Andre Wanlin --- workspaces/code-coverage/.changeset/chatty-otters-work.md | 5 +++++ .../plugins/code-coverage-backend/report.api.md | 4 ++-- .../plugins/code-coverage-backend/src/service/router.ts | 4 ++++ 3 files changed, 11 insertions(+), 2 deletions(-) create mode 100644 workspaces/code-coverage/.changeset/chatty-otters-work.md diff --git a/workspaces/code-coverage/.changeset/chatty-otters-work.md b/workspaces/code-coverage/.changeset/chatty-otters-work.md new file mode 100644 index 000000000..4fad9d4af --- /dev/null +++ b/workspaces/code-coverage/.changeset/chatty-otters-work.md @@ -0,0 +1,5 @@ +--- +'@backstage-community/plugin-code-coverage-backend': patch +--- + +Deprecated `createRouter` and its router options in favour of the new backend system. diff --git a/workspaces/code-coverage/plugins/code-coverage-backend/report.api.md b/workspaces/code-coverage/plugins/code-coverage-backend/report.api.md index 1f94a7c85..bf1c519fe 100644 --- a/workspaces/code-coverage/plugins/code-coverage-backend/report.api.md +++ b/workspaces/code-coverage/plugins/code-coverage-backend/report.api.md @@ -18,10 +18,10 @@ import { UrlReaderService } from '@backstage/backend-plugin-api'; const codeCoveragePlugin: BackendFeature; export default codeCoveragePlugin; -// @public +// @public @deprecated (undocumented) export function createRouter(options: RouterOptions): Promise; -// @public +// @public @deprecated (undocumented) export interface RouterOptions { // (undocumented) auth?: AuthService; diff --git a/workspaces/code-coverage/plugins/code-coverage-backend/src/service/router.ts b/workspaces/code-coverage/plugins/code-coverage-backend/src/service/router.ts index dc124ba9d..5358fcd85 100644 --- a/workspaces/code-coverage/plugins/code-coverage-backend/src/service/router.ts +++ b/workspaces/code-coverage/plugins/code-coverage-backend/src/service/router.ts @@ -38,6 +38,8 @@ import { import { MiddlewareFactory } from '@backstage/backend-defaults/rootHttpRouter'; /** + * @deprecated Please migrate to the new backend system as this will be removed in the future. + * * Options for {@link createRouter}. * * @public @@ -263,6 +265,8 @@ export const makeRouter = async ( }; /** + * @deprecated Please migrate to the new backend system as this will be removed in the future. + * * Creates a code-coverage plugin backend router. * * @public