通过


为您的GitHub仓库添加状态徽章

Azure DevOps 服务 |Azure DevOps Server |Azure DevOps Server 2022

在 GitHub 存储库 README.md 文件中添加 Markdown 语法,以将看板状态显示为徽章。 从板设置复制语法并将其粘贴到 README 文件。

此语法适用于 GitHub.com 和 GitHub Enterprise Server 连接。 对于 GitHub Enterprise Server,服务器必须可通过网络访问Azure DevOps服务。

Prerequisites

Category Requirements
权限 董事会团队的团队管理员项目管理员组的成员。
GitHub 集成 项目连接到要在其中显示徽章的 GitHub 存储库。
团队的现有董事会。 每个团队都会自动获取一个看板。 有关详细信息,请参阅 关于团队和敏捷工具
存储库访问权限 给您添加徽章的 GitHub 存储库的参与者访问权限。

添加状态徽章

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

  2. 选择 齿轮图标以打开板设置。

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

  3. 选择 “状态锁屏提醒”,然后选择或清除 “允许匿名用户访问状态锁屏提醒”。 清除此选项时,未登录的用户仍可以查看徽章。

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

  4. 选择一种徽章类型,然后选择复制以复制 Markdown 语法。

    • 仅显示“正在进行”列 - 排除第一列和最后一列。

    • 包括所有列 - 显示所有列,包括第一列和最后一列。

    • 自定义列 - 设置 columnOptions=2 并添加以逗号分隔的列列表。 将空格编码为 %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 语法。

  6. README.md GitHub 存储库中打开该文件,并粘贴复制的语法。

    徽章显示与您的板对应的值。