Skip to main content

Install the Azure DevOps plugin

Overview​

This step will guide you through the process of installing the Azure DevOps plugin which will add a tab to show Pipeline results, Pull Requests, and Git Tags. It will also add a card to the Overview tab showing the README file from the related repo.

For more details checkout the Azure DevOps Plugin documentation

Step Checklist​

This is the fourth (4) 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 plugin:

  1. Navigate to Plugins and click the "+ Install plugin" button
  2. In the text box that says "Package name" paste in @backstage-community/plugin-azure-devops
  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 Azure DevOps cards click the "View" button
  6. The configuration needed for this plugin is optional and we don't recommend providing any here as it will use the details from Step 1 where we setup the Azure integration. We do need to get it running, click the "Start" button to do that
  7. In the top right you'll see a pulsing message "Applying new configuration..." as the settings get saved
  8. The message will then change to "New configuration applied successfully." with a Reload button, click it to reload the configuration
  9. You now have the Azure DevOps Plugin installed and running!

From here you can now move on to Step 5 where you'll install the Azure DevOps scaffolder actions.

Features​

Here's an example of the Pipeline tab:

Pipeline tab example

And what the logs look like:

Pipeline logs example

The Pull Request tab displays like here:

Pull Request tab example

Then the Git Tags appear like so:

Git Tags tab example

And the last item, the README card is like this:

README card example