Edit

Share via


What is the Azure Boards-GitHub integration?

Azure DevOps Services | Azure DevOps Server 2022 | Azure DevOps Server 2020

Stay aligned and coordinated with Azure Boards and link your code activity and issues from GitHub. This article provides an overview of the integration between Azure Boards and GitHub.

Important

If you want to configure and manage your connections to GitHub.com, use the Azure Boards app for GitHub. The app provides a more streamlined configuration experience and has the advantage of authenticating and operating as the app rather than an individual. After you connect, you can manage the repositories either from Azure Boards or GitHub.com.

Integration between Azure Boards and GitHub

Azure Boards and Azure DevOps support integration with GitHub.com and GitHub Enterprise Server repositories. You can start from either Azure Boards or GitHub to integrate and connect to GitHub repositories to an Azure Boards project.

The latest version of Azure DevOps supports up to 1,000 GitHub repository connections. Azure DevOps 2022 supports up to 500 repositories, and earlier versions support up to 100 repositories.

Note

When you install the Azure DevOps Server 2020.1.1 Patch 2, you can create connections from your Azure DevOps Server to GitHub.com repositories in addition to GitHub Enterprise Server repositories.

Integration features

Azure Boards-GitHub integration supports the following features:

Feature Description More information
Transition work items Transition work items to a "Done" or "Completed" state with the fix, fixes, or fixed commands in GitHub. Use AB# to link from GitHub to Azure Boards work items
Add comments Post a comment to a GitHub commit, pull request, or issue when linked to a work item. Communicating on GitHub
Link from work items Add work item links to a GitHub branch, commit, or pull request. Link GitHub commits, pull requests, branches, and issues to work items in Azure Boards
View GitHub objects Work with GitHub annotations on the board and quickly open linked GitHub commits, pull requests, or issues. View GitHub objects on a board
Configure status badges Add Markdown syntax to the GitHub repository README.md file and show your board status. Add status badges for your GitHub repo
Manage repository access Choose whether all repositories or only repositories you specify can participate in the Azure Boards-GitHub integration. Change repository access
Troubleshoot integration Troubleshoot any issues in the Azure Boards-GitHub integration with your repositories. Resolve connection issues
Enable DevSecOps Configure support for DevSecOps (or Secure DevOps), secure your code with GitHub, so you can safely track your work in Azure Boards. Enable DevSecOps with Azure and GitHub

Connection tasks

You can complete the following connection tasks with Azure Boards-GitHub integration:

Restrictions

The following restrictions apply to Azure Boards-GitHub integration:

  • You can connect a GitHub repository to only one Azure DevOps organization and project.

    If you connect the same GitHub repository to projects defined in two or more Azure DevOps organizations, you might experience unexpected AB# mention linking. For more information, see Troubleshoot Azure Boards-GitHub integration.

  • Azure DevOps can only integrate with GitHub repositories or Azure Repos Git repositories. Integration with other Git repositories isn't supported.

  • You can't query for work items with links to GitHub artifacts. However, you can query for work items with an External Link Count > 0 setting.