From 010d6b7584ba3347d3058c425a51f991d575cd5f Mon Sep 17 00:00:00 2001 From: Alex Eftimie Date: Thu, 8 Jun 2023 21:53:08 +0200 Subject: [PATCH 1/4] Update README.md tiny docs fix for clarity Signed-off-by: Alex Eftimie --- plugins/events-backend-module-github/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/events-backend-module-github/README.md b/plugins/events-backend-module-github/README.md index fb0a0d1c35..f138034410 100644 --- a/plugins/events-backend-module-github/README.md +++ b/plugins/events-backend-module-github/README.md @@ -31,7 +31,7 @@ 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` object in `packages/backend/src/plugins/events.ts`: ```diff +const githubEventRouter = new GithubEventRouter(); From 966c07b2328b3b75a7d8beb38f3dce297ec22a6c Mon Sep 17 00:00:00 2001 From: Alex Eftimie Date: Fri, 9 Jun 2023 08:27:31 +0200 Subject: [PATCH 2/4] Update plugins/events-backend-module-github/README.md Co-authored-by: Patrick Jungermann Signed-off-by: Alex Eftimie --- plugins/events-backend-module-github/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/plugins/events-backend-module-github/README.md b/plugins/events-backend-module-github/README.md index f138034410..9f61353025 100644 --- a/plugins/events-backend-module-github/README.md +++ b/plugins/events-backend-module-github/README.md @@ -31,7 +31,7 @@ Install this module: yarn add --cwd packages/backend @backstage/plugin-events-backend-module-github ``` -Add the event router to the `EventsBackend` object in `packages/backend/src/plugins/events.ts`: +Add the event router to the `EventsBackend` instance in `packages/backend/src/plugins/events.ts`: ```diff +const githubEventRouter = new GithubEventRouter(); From d456f296a6f375d875a92393bbcca82afec1691c Mon Sep 17 00:00:00 2001 From: Alex Eftimie Date: Mon, 12 Jun 2023 00:14:29 +0200 Subject: [PATCH 3/4] Push docs change to other backend modules Signed-off-by: Alex Eftimie --- plugins/events-backend-module-azure/README.md | 4 ++-- plugins/events-backend-module-bitbucket-cloud/README.md | 4 ++-- plugins/events-backend-module-gerrit/README.md | 4 ++-- plugins/events-backend-module-github/README.md | 2 +- plugins/events-backend-module-gitlab/README.md | 4 ++-- 5 files changed, 9 insertions(+), 9 deletions(-) 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 9f61353025..7731d10d24 100644 --- a/plugins/events-backend-module-github/README.md +++ b/plugins/events-backend-module-github/README.md @@ -36,7 +36,7 @@ Add the event router to the `EventsBackend` instance in `packages/backend/src/pl ```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); // [...] From 807416a9ed3978468c3b72c8faa39475f1cf0771 Mon Sep 17 00:00:00 2001 From: Alex Eftimie Date: Wed, 14 Jun 2023 00:04:12 +0200 Subject: [PATCH 4/4] add changest Signed-off-by: Alex Eftimie --- .changeset/yellow-bikes-train.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 .changeset/yellow-bikes-train.md 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