From 17955ad4c74261320eff790cb6ba5b539190f73c Mon Sep 17 00:00:00 2001 From: Tiago Barbosa Date: Mon, 27 Nov 2023 11:13:33 +0000 Subject: [PATCH] refactor(pagerduty plugin): :wastebasket: adding deprecating annotations on Cards and Types exposed by the plugin adding deprecating annotations on Cards and Types exposed by the plugin Signed-off-by: Tiago Barbosa --- plugins/pagerduty/src/plugin.ts | 15 ++++++++++++--- plugins/pagerduty/src/types.ts | 5 ++++- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/plugins/pagerduty/src/plugin.ts b/plugins/pagerduty/src/plugin.ts index 59cc5cd8cc..22f8ae60ee 100644 --- a/plugins/pagerduty/src/plugin.ts +++ b/plugins/pagerduty/src/plugin.ts @@ -30,7 +30,10 @@ export const rootRouteRef = createRouteRef({ id: 'pagerduty', }); -/** @public */ +/** + * @public + * @deprecated This plugin will be removed in a future release. Please use @pagerduty/backstage-plugin plugin instead (https://www.npmjs.com/package/@pagerduty/backstage-plugin). + */ export const pagerDutyPlugin = createPlugin({ id: 'pagerduty', apis: [ @@ -47,7 +50,10 @@ export const pagerDutyPlugin = createPlugin({ ], }); -/** @public */ +/** + * @public + * @deprecated This plugin and it's cards will be removed in a future release. Please use @pagerduty/backstage-plugin plugin instead (https://www.npmjs.com/package/@pagerduty/backstage-plugin). + */ export const EntityPagerDutyCard = pagerDutyPlugin.provide( createComponentExtension({ name: 'EntityPagerDutyCard', @@ -60,7 +66,10 @@ export const EntityPagerDutyCard = pagerDutyPlugin.provide( }), ); -/** @public */ +/** + * @public + * @deprecated This plugin and it's cards will be removed in a future release. Please use @pagerduty/backstage-plugin plugin instead (https://www.npmjs.com/package/@pagerduty/backstage-plugin). + */ export const HomePagePagerDutyCard = pagerDutyPlugin.provide( createCardExtension({ name: 'HomePagePagerDutyCard', diff --git a/plugins/pagerduty/src/types.ts b/plugins/pagerduty/src/types.ts index 9f38b429ef..3ecfb4e745 100644 --- a/plugins/pagerduty/src/types.ts +++ b/plugins/pagerduty/src/types.ts @@ -14,7 +14,10 @@ * limitations under the License. */ -/** @public */ +/** + * @public + * @deprecated This plugin and it's types will be removed in a future release. Please use @pagerduty/backstage-plugin plugin instead (https://www.npmjs.com/package/@pagerduty/backstage-plugin). + */ export type PagerDutyEntity = { integrationKey?: string; serviceId?: string;