From 1d9da597be8c9193fcd15af0875ef7a8cae8a360 Mon Sep 17 00:00:00 2001 From: Brian Fletcher Date: Fri, 10 Mar 2023 13:46:33 +0000 Subject: [PATCH] move review comments Signed-off-by: Brian Fletcher --- .changeset/tall-meals-dress.md | 2 +- docs/integrations/bitbucketCloud/discovery.md | 33 +++++++++---------- docs/integrations/github/discovery.md | 33 ++++++++++--------- docs/integrations/github/org.md | 32 +++++++++--------- 4 files changed, 50 insertions(+), 50 deletions(-) diff --git a/.changeset/tall-meals-dress.md b/.changeset/tall-meals-dress.md index 25f67847ae..3d39c369fe 100644 --- a/.changeset/tall-meals-dress.md +++ b/.changeset/tall-meals-dress.md @@ -4,4 +4,4 @@ Export `DefaultEventBroker` to allow decoupling of the catalog and events backends in the `example-backend`. -Please look at `plugins/events-backend/README.md` for the currently advised was to set up the event backend and catalog providers. +Please look at `plugins/events-backend/README.md` for the currently advised way to set up the event backend and catalog providers. diff --git a/docs/integrations/bitbucketCloud/discovery.md b/docs/integrations/bitbucketCloud/discovery.md index f6ceab9ff7..c5291e3241 100644 --- a/docs/integrations/bitbucketCloud/discovery.md +++ b/docs/integrations/bitbucketCloud/discovery.md @@ -72,30 +72,29 @@ Additionally, you need to decide how you want to receive events from external so Set up your provider ```diff -// packages/backend/src/plugins/catalogEventBasedProviders.ts -+import { CatalogClient } from '@backstage/catalog-client'; +// packages/backend/src/plugins/catalog.ts + import { CatalogBuilder } from '@backstage/plugin-catalog-backend'; +import { BitbucketCloudEntityProvider } from '@backstage/plugin-catalog-backend-module-bitbucket-cloud'; - import { EntityProvider } from '@backstage/plugin-catalog-node'; - import { EventSubscriber } from '@backstage/plugin-events-node'; + import { ScaffolderEntitiesProcessor } from '@backstage/plugin-scaffolder-backend'; + import { Router } from 'express'; import { PluginEnvironment } from '../types'; - export default async function createCatalogEventBasedProviders( -- _: PluginEnvironment, -+ env: PluginEnvironment, - ): Promise> { - const providers: Array< - (EntityProvider & EventSubscriber) | Array - > = []; -- // add your event-based entity providers here -+ providers.push( -+ BitbucketCloudEntityProvider.fromConfig(env.config, { + export default async function createPlugin( + env: PluginEnvironment, + ): Promise { + const builder = await CatalogBuilder.create(env); + builder.addProcessor(new ScaffolderEntitiesProcessor()); ++ const bitBucketProvider = BitbucketCloudEntityProvider.fromConfig(env.config, { + catalogApi: new CatalogClient({ discoveryApi: env.discovery }), + logger: env.logger, + scheduler: env.scheduler, + tokenManager: env.tokenManager, -+ }), -+ ); - return providers.flat(); ++ }); ++ env.eventBroker.subscribe(bitBucketProvider); ++ builder.addEntityProvider(bitBucketProvider); + const { processingEngine, router } = await builder.build(); + await processingEngine.start(); + return router; } ``` diff --git a/docs/integrations/github/discovery.md b/docs/integrations/github/discovery.md index bbbe86a834..da4af4b61b 100644 --- a/docs/integrations/github/discovery.md +++ b/docs/integrations/github/discovery.md @@ -68,21 +68,19 @@ Additionally, you need to decide how you want to receive events from external so Set up your provider ```diff -// packages/backend/src/plugins/catalogEventBasedProviders.ts +// packages/backend/src/plugins/catalog.ts + import { CatalogBuilder } from '@backstage/plugin-catalog-backend'; +import { GithubEntityProvider } from '@backstage/plugin-catalog-backend-module-github'; - import { EntityProvider } from '@backstage/plugin-catalog-node'; - import { EventSubscriber } from '@backstage/plugin-events-node'; + import { ScaffolderEntitiesProcessor } from '@backstage/plugin-scaffolder-backend'; + import { Router } from 'express'; import { PluginEnvironment } from '../types'; - export default async function createCatalogEventBasedProviders( -- _: PluginEnvironment, -+ env: PluginEnvironment, - ): Promise> { - const providers: Array< - (EntityProvider & EventSubscriber) | Array - > = []; -- // add your event-based entity providers here -+ providers.push( -+ GithubEntityProvider.fromConfig(env.config, { + + export default async function createPlugin( + env: PluginEnvironment, + ): Promise { + const builder = await CatalogBuilder.create(env); + builder.addProcessor(new ScaffolderEntitiesProcessor()); ++ const githubProvider = GithubEntityProvider.fromConfig(env.config, { + logger: env.logger, + // optional: alternatively, use scheduler with schedule defined in app-config.yaml + schedule: env.scheduler.createScheduledTaskRunner({ @@ -91,9 +89,12 @@ Set up your provider + }), + // optional: alternatively, use schedule + scheduler: env.scheduler, -+ }), -+ ); - return providers.flat(); ++ }); ++ env.eventBroker.subscribe(githubProvider); ++ builder.addEntityProvider(demoProvider); + const { processingEngine, router } = await builder.build(); + await processingEngine.start(); + return router; } ``` diff --git a/docs/integrations/github/org.md b/docs/integrations/github/org.md index 0aa9997bae..c0b7a74d69 100644 --- a/docs/integrations/github/org.md +++ b/docs/integrations/github/org.md @@ -75,21 +75,19 @@ Additionally, you need to decide how you want to receive events from external so Set up your provider ```diff -// packages/backend/src/plugins/catalogEventBasedProviders.ts +// packages/backend/src/plugins/catalog.ts + import { CatalogBuilder } from '@backstage/plugin-catalog-backend'; +import { GithubOrgEntityProvider } from '@backstage/plugin-catalog-backend-module-github'; - import { EntityProvider } from '@backstage/plugin-catalog-node'; - import { EventSubscriber } from '@backstage/plugin-events-node'; + import { ScaffolderEntitiesProcessor } from '@backstage/plugin-scaffolder-backend'; + import { Router } from 'express'; import { PluginEnvironment } from '../types'; - export default async function createCatalogEventBasedProviders( -- _: PluginEnvironment, -+ env: PluginEnvironment, - ): Promise> { - const providers: Array< - (EntityProvider & EventSubscriber) | Array - > = []; -- // add your event-based entity providers here -+ providers.push( -+ GithubOrgEntityProvider.fromConfig(env.config, { + + export default async function createPlugin( + env: PluginEnvironment, + ): Promise { + const builder = await CatalogBuilder.create(env); + builder.addProcessor(new ScaffolderEntitiesProcessor()); ++ const githubOrgProvider = GithubOrgEntityProvider.fromConfig(env.config, { + id: 'production', + orgUrl: 'https://github.com/backstage', + logger: env.logger, @@ -97,9 +95,11 @@ Set up your provider + frequency: { minutes: 60 }, + timeout: { minutes: 15 }, + }), -+ }), -+ ); - return providers.flat(); ++ env.eventBroker.subscribe(githubOrgProvider); ++ builder.addEntityProvider(githubOrgProvider); + const { processingEngine, router } = await builder.build(); + await processingEngine.start(); + return router; } ```