为 GitHub 存储库添加状态徽章

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

可以将 Markdown 语法添加到 GitHub 存储库 README.md 文件中,以显示该存储库中的板状态。 通过添加从面板设置中选择的语法来显示状态。

无论你是将项目连接到 GitHub.com 还是 GitHub Enterprise Server 存储库,显示的语法都有效。 对于 GitHub Enterprise Server,服务器必须可以通过网络访问 Azure DevOps Services。

Prerequisites

Category Requirements
Permissions 负责你想要修改的团队设置的团队管理员,或项目管理员组的成员。
与 GitHub 集成 将项目连接到 GitHub 存储库,你要作为链接来源或目标对象的提交和拉取请求将存在于该存储库中。
电路板配置 要配置的面板。 添加团队时,请为该团队添加面板。 有关详细信息,请参阅 关于团队和敏捷工具
存储库访问权限 若要将状态徽章添加到 GitHub.com 存储库:存储库参与者。

添加状态徽章

  1. 登录到 Azure Boards 并打开面板

  2. 选择 齿轮图标以配置面板并设置常规团队设置。

    打开面板设置的屏幕截图。

  3. 选择“状态锁屏提醒”,然后选中或取消选中“允许匿名用户访问状态锁屏提醒”。 取消选中后,未登录的用户仍可查看状态锁屏提醒。

    面板“设置”对话框,“状态锁屏提醒”选项卡的屏幕截图。

  4. 选择所需的徽章类型,然后选择 复制图标,复制徽章的 Markdown 语法。

    • 仅显示“正在进行”列将忽略第一列和最后一列。
    • 包含所有列包括面板的第一列和最后一列。
    • 你可以自定义列集,方法是为 columnOptions 指定 2,并指定要显示的以逗号分隔的面板列的列表。 例如 ?columnOptions=2&columns=Proposed,Committed,In%20Progress,In%20Review,如以下语法所示。 对于包含空格的列标签,必须使用 %20 对空格进行编码。 例如,In%20Progress
     [![Board Status](https://dev.azure.com/fabrikam/677da0fb-b067-4f77-b89b-f32c12bb8617/cdf5e823-1179-4503-9fb1-a45e2c1bc6d4/_apis/work/boardbadge/6fa7b56f-d27c-4e96-957d-f9e7b0f56705?columnOptions=2&columns=Proposed,Committed,In%20Progress,In%20Review)](https://dev.azure.com/fabrikam/677da0fb-b067-4f77-b89b-f32c12bb8617/_boards/board/t/cdf5e823-1179-4503-9fb1-a45e2c1bc6d4/Microsoft.RequirementCategory/)
    

    显示了类似下面的锁屏提醒。

    显示已呈现的徽章的屏幕截图。

  5. 完成后,选择“保存”

    您可以配置的唯一设置是“允许匿名用户访问状态锁屏提醒”设置下面的徽章类型仅切换 Markdown 语法,让你可以从示例 Markdown图像 URL 值复制。

  6. 在 GitHub 存储库中打开自述文件,粘贴复制的语法,以显示锁屏提醒。

    你应该能看到与你所选择且值与你的面板相对应的相同预览图像。