Welcome to the events-backend-module-gitlab backend plugin!
This plugin is a module for the events-backend backend plugin
and extends it with an GitlabEventRouter.
The event router will subscribe to the topic gitlab
and route the events to more concrete topics based on the value
of the provided $.event_name payload field.
Examples:
$.event_name |
topic |
|---|---|
push |
gitlab.push |
merge_request |
gitlab.merge_request |
Please find all possible webhook event types at the official documentation.
Install the events-backend plugin.
Install this module:
# From your Backstage root directory
yarn add --cwd packages/backend @backstage/plugin-events-backend-module-gitlabAdd the event router to the EventsBackend:
+const gitlabEventRouter = new GitlabEventRouter();
EventsBackend
+ .addPublishers(gitlabEventRouter)
+ .addSubscribers(gitlabEventRouter);
// [...]Add the token validator for the topic gitlab:
// at packages/backend/src/plugins/events.ts
+ import { createGitlabTokenValidator } from '@backstage/plugin-events-backend-module-gitlab';
// [...]
const http = HttpPostIngressEventPublisher.fromConfig({
config: env.config,
ingresses: {
+ gitlab: {
+ validator: createGitlabTokenValidator(env.config),
+ },
},
logger: env.logger,
});Additionally, you need to add the configuration:
events:
modules:
gitlab:
webhookSecret: your-secret-token