diff --git a/.changeset/yellow-bikes-train.md b/.changeset/yellow-bikes-train.md new file mode 100644 index 0000000000..8093af44d3 --- /dev/null +++ b/.changeset/yellow-bikes-train.md @@ -0,0 +1,9 @@ +--- +'@backstage/plugin-events-backend-module-bitbucket-cloud': patch +'@backstage/plugin-events-backend-module-gerrit': patch +'@backstage/plugin-events-backend-module-github': patch +'@backstage/plugin-events-backend-module-gitlab': patch +'@backstage/plugin-events-backend-module-azure': patch +--- + +fix Installation documentation diff --git a/plugins/events-backend-module-azure/README.md b/plugins/events-backend-module-azure/README.md index 214c00e2fd..26bffbc45d 100644 --- a/plugins/events-backend-module-azure/README.md +++ b/plugins/events-backend-module-azure/README.md @@ -31,12 +31,12 @@ Install this module: yarn add --cwd packages/backend @backstage/plugin-events-backend-module-azure ``` -Add the event router to the `EventsBackend`: +Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`: ```diff +const azureEventRouter = new AzureDevOpsEventRouter(); - EventsBackend +new EventsBackend(env.logger) + .addPublishers(azureEventRouter) + .addSubscribers(azureEventRouter); // [...] diff --git a/plugins/events-backend-module-bitbucket-cloud/README.md b/plugins/events-backend-module-bitbucket-cloud/README.md index c58529ed7a..60fdf52af9 100644 --- a/plugins/events-backend-module-bitbucket-cloud/README.md +++ b/plugins/events-backend-module-bitbucket-cloud/README.md @@ -31,12 +31,12 @@ Install this module: yarn add --cwd packages/backend @backstage/plugin-events-backend-module-bitbucket-cloud ``` -Add the event router to the `EventsBackend`: +Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`: ```diff +const bitbucketCloudEventRouter = new BitbucketCloudEventRouter(); - EventsBackend +new EventsBackend(env.logger) + .addPublishers(bitbucketCloudEventRouter) + .addSubscribers(bitbucketCloudEventRouter); // [...] diff --git a/plugins/events-backend-module-gerrit/README.md b/plugins/events-backend-module-gerrit/README.md index 933b7a172f..1808ef46ba 100644 --- a/plugins/events-backend-module-gerrit/README.md +++ b/plugins/events-backend-module-gerrit/README.md @@ -30,12 +30,12 @@ Install this module: yarn add --cwd packages/backend @backstage/plugin-events-backend-module-gerrit ``` -Add the event router to the `EventsBackend`: +Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`: ```diff +const gerritEventRouter = new GerritEventRouter(); - EventsBackend +new EventsBackend(env.logger) + .addPublishers(gerritEventRouter) + .addSubscribers(gerritEventRouter); // [...] diff --git a/plugins/events-backend-module-github/README.md b/plugins/events-backend-module-github/README.md index fb0a0d1c35..7731d10d24 100644 --- a/plugins/events-backend-module-github/README.md +++ b/plugins/events-backend-module-github/README.md @@ -31,12 +31,12 @@ Install this module: yarn add --cwd packages/backend @backstage/plugin-events-backend-module-github ``` -Add the event router to the `EventsBackend`: +Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`: ```diff +const githubEventRouter = new GithubEventRouter(); - EventsBackend +new EventsBackend(env.logger) + .addPublishers(githubEventRouter) + .addSubscribers(githubEventRouter); // [...] diff --git a/plugins/events-backend-module-gitlab/README.md b/plugins/events-backend-module-gitlab/README.md index dbe9f7bfe3..13e30659a6 100644 --- a/plugins/events-backend-module-gitlab/README.md +++ b/plugins/events-backend-module-gitlab/README.md @@ -30,12 +30,12 @@ Install this module: yarn add --cwd packages/backend @backstage/plugin-events-backend-module-gitlab ``` -Add the event router to the `EventsBackend`: +Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`: ```diff +const gitlabEventRouter = new GitlabEventRouter(); - EventsBackend +new EventsBackend(env.logger) + .addPublishers(gitlabEventRouter) + .addSubscribers(gitlabEventRouter); // [...]