Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Azure DevOps Services | Azure DevOps Server | Azure DevOps Server 2022
Add Markdown syntax to a GitHub repo README.md file to display your board status as a badge. Copy the syntax from your board settings and paste it into the README.
This syntax works for both GitHub.com and GitHub Enterprise Server connections. For GitHub Enterprise Server, your server must be network accessible to Azure DevOps Services.
Prerequisites
| Category | Requirements |
|---|---|
| Permissions | Team administrator for the board's team, or member of the Project Administrators group. |
| GitHub integration | Project connected to the GitHub repository where you want to display the badge. |
| Board | An existing board for the team. Each team gets a board automatically. For more information, see About teams and Agile tools. |
| Repository access | Contributor access to the GitHub repository where you add the badge. |
Add a status badge
Sign in to Azure Boards and open your board.
Select
gear icon to open board settings.
Select Status badge, then select or clear Allow anonymous users to access the status badge. When this option is cleared, users who aren't signed in can still view the badge.
Select a badge type, then select
Copy to copy the Markdown syntax.Show "In progress" columns only — excludes the first and last columns.
Include all columns — shows all columns, including the first and last.
Custom columns — set
columnOptions=2and add a comma-delimited list of columns. Encode spaces as%20(for example,In%20Progress).Example syntax:
[](https://dev.azure.com/fabrikam/677da0fb-b067-4f77-b89b-f32c12bb8617/_boards/board/t/cdf5e823-1179-4503-9fb1-a45e2c1bc6d4/Microsoft.RequirementCategory/)The rendered badge looks similar to the following image.
Select Save.
The Allow anonymous users to access the status badge option is the only configurable setting. The badge type selection only changes the Markdown syntax available to copy.
Open the
README.mdfile in your GitHub repo and paste the copied syntax.The badge renders with values that correspond to your board.