From 0cd6d20f712d5c45974567e396027c283ff270fc Mon Sep 17 00:00:00 2001 From: Deepankumar Loganathan Date: Tue, 20 Feb 2024 15:03:33 +0100 Subject: [PATCH] fixed plugin export and README Signed-off-by: Deepankumar Loganathan --- plugins/azure-sites-backend/README.md | 6 ++++-- plugins/azure-sites-backend/api-report.md | 3 ++- plugins/azure-sites-backend/src/index.ts | 2 +- 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/plugins/azure-sites-backend/README.md b/plugins/azure-sites-backend/README.md index 843e9ff92b..554a3d0cc4 100644 --- a/plugins/azure-sites-backend/README.md +++ b/plugins/azure-sites-backend/README.md @@ -51,14 +51,17 @@ Here's how to get the backend plugin up and running: } from '@backstage/plugin-azure-sites-backend'; import { Router } from 'express'; import { PluginEnvironment } from '../types'; + import { CatalogClient } from '@backstage/catalog-client' export default async function createPlugin( env: PluginEnvironment, ): Promise { return await createRouter({ + const catalogApi = new CatalogClient({ discoveryApi: env.discovery }) logger: env.logger, azureSitesApi: AzureSitesApi.fromConfig(env.config), permissions: env.permissions, + catalogApi }); } ``` @@ -115,13 +118,12 @@ In your `packages/backend/src/index.ts` make the following changes: ```diff import { createBackend } from '@backstage/backend-defaults'; -+ import { azureSitesPlugin } from '@backstage/plugin-azure-sites-backend; const backend = createBackend(); // ... other feature additions -+ backend.add(azureSitesPlugin); ++ backend.add(import('@backstage/plugin-azure-sites-backend')); // ... diff --git a/plugins/azure-sites-backend/api-report.md b/plugins/azure-sites-backend/api-report.md index 5adc3c3c47..9c2875e286 100644 --- a/plugins/azure-sites-backend/api-report.md +++ b/plugins/azure-sites-backend/api-report.md @@ -52,7 +52,8 @@ export class AzureSitesConfig { } // @public -export const azureSitesPlugin: () => BackendFeature; +const azureSitesPlugin: () => BackendFeature; +export default azureSitesPlugin; // @public (undocumented) export function createRouter(options: RouterOptions): Promise; diff --git a/plugins/azure-sites-backend/src/index.ts b/plugins/azure-sites-backend/src/index.ts index 22d120acc5..7f56b8e92a 100644 --- a/plugins/azure-sites-backend/src/index.ts +++ b/plugins/azure-sites-backend/src/index.ts @@ -17,4 +17,4 @@ export * from './service/router'; export * from './api'; export * from './config'; -export { azureSitesPlugin } from './plugin'; +export { azureSitesPlugin as default } from './plugin';