为 GitHub 存储库添加状态徽章

  • 项目

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

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

注意

需要 Azure DevOps Server 2019 Update 1 或更高版本。

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

先决条件

  • Azure Boards 项目必须连接到 GitHub 存储库，其中存在你要链接到/从中链接的提交和拉取请求。 有关详细信息，请参阅 Azure Boards- GitHub 集成。
  • 必须具有要配置的看板面板。 添加团队时，可以为该团队添加看板面板。 有关详细信息，请参阅 关于团队和敏捷工具。
  • 必须将你添加到要修改的团队设置的团队管理员角色中，或者成为“项目管理员”安全组的成员。 若要加入，请参阅添加团队管理员或更改项目级权限。
  • 若要将状态徽章添加到 GitHub.com 存储库，你必须是存储库的参与者。

添加状态徽章

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

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

    Screenshot of opening board settings.

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

    Screenshot of Kanban Board Settings dialog, Status badge tab.

    Screenshot of Kanban Board Settings dialog, Status badge tab, Azure DevOps Server 2019.

  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/)

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

    Screenshot showing badge rendered.

  5. 完成后，选择“保存”。

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

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

    你应该会看到所选的同一预览图像，其中包含与看板面板对应的值。