Skip to main content

Install the Azure DevOps Annotator Processor

Overview​

This step will guide you through the process of installing the Azure DevOps Annotator Processor which will add the needed annotations to your entities for you which will then help enable the features of the Azure DevOps plugin.

For more details checkout the Azure DevOps Annotator Processor documentation

Step Checklist​

This is the third (3) step in this guide, once completed you can move onto the next step.

  1. Setup the Azure integration in App Settings
  2. Setup Azure DevOps Discovery
  3. Install the Azure DevOps Annotator Processor
  4. Install the Azure DevOps plugin
  5. Install the Azure DevOps scaffolder actions
  6. Install the Azure DevOps Wiki collator

Walkthrough​

Here's how to install the Azure DevOps Annotator Processor:

  1. Navigate to Plugins and click the "+ Install plugin" button
  2. In the text box that says "Package name" paste in @backstage-community/plugin-catalog-backend-module-azure-devops-annotator-processor
  3. Then check the "I accept that packages installed have access to all data and configuration in Portal." box and click the "Install" button
  4. Once it's done the installation process you can click on the "Finish" button
  5. You'll now find yourself back at the main Plugins screen, from here on the Catalog card click on the "View" button
  6. Then click on the Modules tab
  7. Now search for the @backstage-community/plugin-catalog-backend-module-azure-devops-annotator-processor card and click on "Manage module"
  8. There's no configuration needed for this plugin but we need to get it running, click the "Start" button
  9. In the top right you'll see a pulsing message "Applying new configuration..." as the settings get saved
  10. The message will then change to "New configuration applied successfully." with a Reload button, click it to reload the configuration
  11. You now have the Azure DevOps Annotator Processor installed and running!

From here you can now move on to Step 4 where you'll install the Azure DevOps Plugin.

Features​

Here's an example of the annotations being added for you by this processor:

Azure DevOps Annotator Processor example