initial changes

Signed-off-by: Andre Wanlin <awanlin@spotify.com> Signed-off-by: Andre Wanlin <awanlin@spotify.com> Signed-off-by: Andre Wanlin <awanlin@spotify.com> Signed-off-by: Andre Wanlin <awanlin@spotify.com>
2023-11-23 18:10:40 -06:00
parent 0c930f8df1
commit 043b724c56
18 changed files with 576 additions and 14 deletions
@@ -89,6 +89,29 @@ In your `packages/backend/src/index.ts` make the following changes:
  backend.start();
 ```

+## Processor
+
+The Azure DevOps backend plugin includes the `AzureDevOpsAnnotatorProcessor` which will automatically add the needed annotations for you. Here's how to install it:
+
+```diff
+  import { CatalogBuilder } from '@backstage/plugin-catalog-backend';
+  import { ScaffolderEntitiesProcessor } from '@backstage/plugin-catalog-backend-module-scaffolder-entity-model';
+  import { Router } from 'express';
+  import { PluginEnvironment } from '../types';
+ import { AzureDevOpsAnnotatorProcessor } from '@backstage/plugin-azure-devops-backend';
+
+  export default async function createPlugin(
+    env: PluginEnvironment,
+  ): Promise<Router> {
+    const builder = await CatalogBuilder.create(env);
+    builder.addProcessor(new ScaffolderEntitiesProcessor());
+   builder.addProcessor(AzureDevOpsAnnotatorProcessor.fromConfig(env.config));
+    const { processingEngine, router } = await builder.build();
+    await processingEngine.start();
+    return router;
+  }
+```
+
 ## Links

 - [Frontend part of the plugin](https://github.com/backstage/backstage/tree/master/plugins/azure-devops)