From 4389d4f6684796dcc31190590774a31c717557e3 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Mon, 21 Dec 2020 11:24:07 -0500 Subject: [PATCH 1/5] Update link to use catalog-import --- .../api-docs/src/components/ApiExplorerPage/ApiExplorerPage.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/api-docs/src/components/ApiExplorerPage/ApiExplorerPage.tsx b/plugins/api-docs/src/components/ApiExplorerPage/ApiExplorerPage.tsx index 398268caf2..a602877525 100644 --- a/plugins/api-docs/src/components/ApiExplorerPage/ApiExplorerPage.tsx +++ b/plugins/api-docs/src/components/ApiExplorerPage/ApiExplorerPage.tsx @@ -37,7 +37,7 @@ export const ApiExplorerPage = () => { variant="contained" color="primary" component={RouterLink} - to="/register-component" + to="/catalog-import" > Register Existing API From 20ec8ddc996fd583780d8efb60e0d346e04a4842 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Mon, 21 Dec 2020 11:29:40 -0500 Subject: [PATCH 2/5] Reference deprecation --- plugins/register-component/README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/plugins/register-component/README.md b/plugins/register-component/README.md index d324b3941f..0abf27590f 100644 --- a/plugins/register-component/README.md +++ b/plugins/register-component/README.md @@ -1,5 +1,7 @@ # Register component plugin +> This plugin is deprecated in favor of [`@backstage/catalog-import`](https://github.com/backstage/backstage/tree/master/plugins/catalog-import), and will be soon removed from the project. + Welcome to the register-component plugin! This plugin allows you to submit your Backstage component using your software's YAML config. From 9161531b2b5c6786cc4b4723ee5af838e4548bfc Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Mon, 21 Dec 2020 11:32:14 -0500 Subject: [PATCH 3/5] Add changeset --- .changeset/gentle-dragons-marry.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/gentle-dragons-marry.md diff --git a/.changeset/gentle-dragons-marry.md b/.changeset/gentle-dragons-marry.md new file mode 100644 index 0000000000..d9ef443932 --- /dev/null +++ b/.changeset/gentle-dragons-marry.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-api-docs': patch +--- + +Link register API to catalog-import plugin From 1517876fd8d67b77c4f24e5bc20d9e70657d23b9 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Mon, 21 Dec 2020 12:46:17 -0500 Subject: [PATCH 4/5] Add register-compomnent changeset --- .changeset/famous-eagles-swim.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 .changeset/famous-eagles-swim.md diff --git a/.changeset/famous-eagles-swim.md b/.changeset/famous-eagles-swim.md new file mode 100644 index 0000000000..49f2724b5b --- /dev/null +++ b/.changeset/famous-eagles-swim.md @@ -0,0 +1,5 @@ +--- +'@backstage/plugin-register-component': patch +--- + +Register component plugin is deprecated in favor of @backstage/plugin-catalog-import From f78cf32e6782842f3fdaa8d219ca22b8939529c8 Mon Sep 17 00:00:00 2001 From: Adam Harvey Date: Mon, 21 Dec 2020 14:00:39 -0500 Subject: [PATCH 5/5] Add deprecated TSDOC --- plugins/register-component/src/components/Router.tsx | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/plugins/register-component/src/components/Router.tsx b/plugins/register-component/src/components/Router.tsx index eee7fd3806..16aa1fa695 100644 --- a/plugins/register-component/src/components/Router.tsx +++ b/plugins/register-component/src/components/Router.tsx @@ -20,6 +20,13 @@ import { RouteRef } from '@backstage/core'; // As we don't know which path the catalog's router mounted on // We need to inject this from the app + +/** + * Provides a router for registering a component. + * + * @deprecated The router for this component is deprecated and replaced with the `catalog-import` plugin. + * @see https://github.com/backstage/backstage/tree/master/plugins/catalog-import + */ export const Router = ({ catalogRouteRef }: { catalogRouteRef: RouteRef }) => (