From 17d45dbf1049530d155e927dd171e93d23d884e3 Mon Sep 17 00:00:00 2001 From: Patrick Jungermann Date: Mon, 18 Jul 2022 22:44:38 +0200 Subject: [PATCH] chore(catalog): deprecate `AwsS3DiscoveryProcessor` Deprecate `AwsS3DiscoveryProcessor` in favor of `AwsS3EntityProvider` (since v0.1.4). Signed-off-by: Patrick Jungermann --- .changeset/olive-tips-camp.md | 8 +++++++ docs/integrations/aws-s3/discovery.md | 24 ------------------- .../catalog-backend-module-aws/api-report.md | 2 +- .../src/processors/AwsS3DiscoveryProcessor.ts | 1 + 4 files changed, 10 insertions(+), 25 deletions(-) create mode 100644 .changeset/olive-tips-camp.md diff --git a/.changeset/olive-tips-camp.md b/.changeset/olive-tips-camp.md new file mode 100644 index 0000000000..8b65eed574 --- /dev/null +++ b/.changeset/olive-tips-camp.md @@ -0,0 +1,8 @@ +--- +'@backstage/plugin-catalog-backend-module-aws': patch +--- + +Deprecate `AwsS3DiscoveryProcessor` in favor of `AwsS3EntityProvider` (since v0.1.4). + +You can find a migration guide at +[the release notes for v0.1.4](https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-aws/CHANGELOG.md#014). diff --git a/docs/integrations/aws-s3/discovery.md b/docs/integrations/aws-s3/discovery.md index 40739937a4..9e9e6ebede 100644 --- a/docs/integrations/aws-s3/discovery.md +++ b/docs/integrations/aws-s3/discovery.md @@ -76,27 +76,3 @@ builder.addEntityProvider( }), ); ``` - -## Alternative Processor - -As alternative to the entity provider `AwsS3EntityProvider` -you can still use the `AwsS3DiscoveryProcessor`. - -```yaml -# app-config.yaml - -catalog: - locations: - - type: s3-discovery - target: https://sample-bucket.s3.us-east-2.amazonaws.com/prefix/ -``` - -```ts -/* packages/backend/src/plugins/catalog.ts */ - -import { AwsS3DiscoveryProcessor } from '@backstage/plugin-catalog-backend-module-aws'; - -const builder = await CatalogBuilder.create(env); -/** ... other processors ... */ -builder.addProcessor(new AwsS3DiscoveryProcessor(env.reader)); -``` diff --git a/plugins/catalog-backend-module-aws/api-report.md b/plugins/catalog-backend-module-aws/api-report.md index 4e8db41fac..b1f6358979 100644 --- a/plugins/catalog-backend-module-aws/api-report.md +++ b/plugins/catalog-backend-module-aws/api-report.md @@ -54,7 +54,7 @@ export class AwsOrganizationCloudAccountProcessor implements CatalogProcessor { ): Promise; } -// @public +// @public @deprecated export class AwsS3DiscoveryProcessor implements CatalogProcessor { constructor(reader: UrlReader); // (undocumented) diff --git a/plugins/catalog-backend-module-aws/src/processors/AwsS3DiscoveryProcessor.ts b/plugins/catalog-backend-module-aws/src/processors/AwsS3DiscoveryProcessor.ts index 0390defb2a..84f2289c94 100644 --- a/plugins/catalog-backend-module-aws/src/processors/AwsS3DiscoveryProcessor.ts +++ b/plugins/catalog-backend-module-aws/src/processors/AwsS3DiscoveryProcessor.ts @@ -31,6 +31,7 @@ import limiterFactory from 'p-limit'; * `https://testbucket.s3.us-east-2.amazonaws.com`. * * @public + * @deprecated Use the `AwsS3EntityProvider` instead (see https://github.com/backstage/backstage/blob/master/plugins/catalog-backend-module-aws/CHANGELOG.md#014). */ export class AwsS3DiscoveryProcessor implements CatalogProcessor { constructor(private readonly reader: UrlReader) {}