Azure DevOps

👍

Covered in this doc

The Percy Azure DevOps app will update the pull request summary if there are visual differences needing review, and will show which team member approved them. It will also help us provide smarter comparisons for you, by picking more relevant base builds.

Install the Percy Azure DevOps Integration


Navigate to your Organization Settings > Integrations. Click the "Install" button in the Azure DevOps row.

🚧

Note: Azure DevOps requires that you have the "admin" role in an organization to add integrations.

When you click “Install Azure DevOps App,” you’ll be directed to Microsoft Visual Studio for authorization.

By default, Percy will be installed with:

  • read access to code, commits, and version control artifacts
  • read and write access to commit status and pull request status

Once installed, the next step is to link a Percy project to an Azure DevOps repository.

Link Percy Projects with Azure DevOps Repositories


You can manage your linked repositories by selecting "Edit settings" under Organization Settings > Integrations.

You can also manage an individual project's linked repository. Head to your Project Settings and scroll to the "Link a repository" section.

Your repositories will automatically populate and be searchable from the drop-down when you "Select a repository."

Run and Review Builds in Azure DevOps


Once you've installed the app and linked projects with repositories, subsequent Percy builds will show metadata from Azure DevOps and Percy will automatically update the pull request summary if there are visual differences waiting for review.

📘

Note: By default, Percy approvals aren’t required before merging. You can enable this feature in the branch policies once you’re ready for it.

Clicking the status header will take you directly to the Percy build UI showing all visual differences to be reviewed. Approving a build in Percy sets the Percy status in Azure DevOps to green/successful, so that your team can see that any visual changes were reviewed and approved.