Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
zhammer committed Aug 25, 2024
1 parent 36fc842 commit 9700bd6
Showing 1 changed file with 6 additions and 15 deletions.
21 changes: 6 additions & 15 deletions plugins/gitlab-catalog-backend/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,21 +31,12 @@ Enriches existing `User` entities with information from Gitlab, notably the user

#### Installation

Add the following to your `packages/backend/catalog.ts`:
Add the following to your `packages/backend/index.ts`:

```ts
import { GitlabUserProcessor } from '@seatgeek/backstage-plugin-gitlab-catalog-backend';
export default async function createPlugin(
env: PluginEnvironment,
): Promise<Router> {
const builder = CatalogBuilder.create(env);
builder.addProcessor(
// Add the gitlab user processor
GitlabUserProcessor.fromConfig(env.config, env.logger),
);
const { processingEngine, router } = await builder.build();
processingEngine.start();
return router;
}
// in your imports
import { catalogModuleGitlabUserProcessor } from '@seatgeek/backstage-plugin-gitlab-catalog-backend';
// in your catalog modules
backend.add(catalogModuleGitlabUserProcessor());
```

0 comments on commit 9700bd6

Please sign in to comment.