Files
backstage/plugins/events-backend-module-bitbucket-cloud/README.md
T
Patrick Jungermann af76a957ba feat(events): add default exports for new backend system
Add default exports for event modules
to be used with the new backend system
as well as documentation on how to install.

Signed-off-by: Patrick Jungermann <Patrick.Jungermann@gmail.com>
2024-01-09 01:37:24 +01:00

1.6 KiB

events-backend-module-bitbucket-cloud

Welcome to the events-backend-module-bitbucket-cloud backend plugin!

This plugin is a module for the events-backend backend plugin and extends it with an BitbucketCloudEventRouter.

The event router will subscribe to the topic bitbucketCloud and route the events to more concrete topics based on the value of the provided x-event-key metadata field.

Examples:

x-event-key topic
repo:push bitbucketCloud.repo:push
repo:updated bitbucketCloud.repo:updated
pullrequest:created bitbucketCloud.pullrequest:created

Please find all possible webhook event types at the official documentation.

Installation

Install the events-backend plugin.

Install this module:

# From your Backstage root directory
yarn add --cwd packages/backend @backstage/plugin-events-backend-module-bitbucket-cloud

Add to backend

backend.add(
  import('@backstage/plugin-events-backend-module-bitbucket-cloud/alpha'),
);

Add to backend (old)

Add the event router to the EventsBackend instance in packages/backend/src/plugins/events.ts:

+const bitbucketCloudEventRouter = new BitbucketCloudEventRouter();

new EventsBackend(env.logger)
+  .addPublishers(bitbucketCloudEventRouter)
+  .addSubscribers(bitbucketCloudEventRouter);
// [...]