chore(catalog): deprecate AwsS3DiscoveryProcessor

Deprecate `AwsS3DiscoveryProcessor` in favor of `AwsS3EntityProvider` (since v0.1.4).

Signed-off-by: Patrick Jungermann <Patrick.Jungermann@gmail.com>

.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).

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));
-```

plugins/catalog-backend-module-aws/api-report.md

@@ -54,7 +54,7 @@ export class AwsOrganizationCloudAccountProcessor implements CatalogProcessor {
   ): Promise<boolean>;
 }
 
-// @public
+// @public @deprecated
 export class AwsS3DiscoveryProcessor implements CatalogProcessor {
   constructor(reader: UrlReader);
   // (undocumented)

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) {}