通过

安装适用于 GitHub 的 Azure Boards 应用

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

在本快速入门中，你将安装用于 GitHub 的 Azure Boards 应用，将 Azure Boards 连接到 GitHub 存储库。 将 Azure Boards 项目连接到 GitHub.com 存储库时，支持在 GitHub 提交与工作项的拉取请求之间进行关联。 使用 Azure Boards 来计划和跟踪工作时，可使用 GitHub 进行软件开发。 在 GitHub 帐户或组织中安装 GitHub 的 Azure Boards 应用后，选择要从项目连接到的 GitHub 存储库。

若要大致了解适用于 GitHub 的 Azure Boards 应用支持的集成，请参阅 Azure Boards-GitHub 集成。

Prerequisites

Category Requirements
Permissions - 项目集合管理员 组的成员。 如果创建了项目，则拥有权限。
- 安装 Azure Boards 应用的 GitHub 组织的管理员或所有者。
- 读取 GitHub 存储库的 权限。
项目成员身份 项目成员.

Important

如果存储库已使用其他身份验证类型（如 OAuth）进行连接，则必须在使用 GitHub 应用重新连接之前从现有连接中删除该存储库。 在配置 GitHub 应用之前，请按本文中后文添加或删除 GitHub 存储库所提供的步骤进行操作。

如果你是多个 GitHub 存储库的管理员，则可将 Azure DevOps 组织连接到这些存储库。 不应将 GitHub 存储库连接到多个 Azure DevOps 组织。

安装并配置 Azure Boards 应用

安装顺序可能因帐户配置而异。 如有必要，请在以下步骤之间按照屏幕上的提示进行操作。

  1. 转到 GitHub Marketplace 中的 Azure Boards 应用。

  2. 在 “计划和定价”下，在 “免费”下，选择“ 安装”。

  3. 在 “安装”和“授权 Azure Boards”中，选择要连接到 Azure Boards 的存储库，然后选择“ 安装和授权”。

    此示例使用 所有存储库：

    屏幕截图显示了“安装和授权”页，其中选择了所有存储库。

  4. 选择要连接到 GitHub.com 的 Azure DevOps 组织和 Azure Boards 项目。

    屏幕截图显示“设置 Azure Boards 项目”页面，您可以在其中选择组织和项目。

    一次只能连接一个项目。 如果要连接其他项目，可以稍后按照本文后面的配置其他项目或存储库中所述进行连接。

授予 Azure Boards 组织访问权限

如有必要，若要授予 GitHub 对 Azure DevOps 组织的访问权限，请执行以下步骤。

  1. 在 GitHub Web 门户中，从配置文件菜单打开设置。

    屏幕截图显示了配置文件中的“设置”选项。

  2. 在集成下选择应用程序。

  3. 选择授权 GitHub 应用>Azure Boards。

    屏幕截图显示了已授权的 GitHub 应用，其中突出显示了 Azure Boards。

  4. 在组织访问权限下，解决可能出现的所有问题。 选择“授予”，向任何显示为具有“挂起的访问请求”的组织授予访问权限。

    屏幕截图显示了具有访问权限与不具访问权限的组织。

检查第三方应用程序访问策略

确保 GitHub 组织允许对 Azure Boards 应用进行第三方应用程序访问。 如果第三方访问受到限制，则从 Azure DevOps 添加存储库可能会显示空列表或生成错误。

启用访问权限：

  1. 在 GitHub 中，打开组织并转到“设置 > OAuth 应用策略”。

  2. 专门批准 Azure Boards 应用（建议），或删除所有第三方应用程序的限制。

    屏幕截图显示了第三方应用程序访问策略。

注释

你必须是组织所有者或管理员才能更改此设置。

使用连接

此时，Azure Boards-GitHub 集成已经完成。 可跳过后续步骤或完成这些步骤，从而了解此连接所支持的功能。

  1. 在看板上，选择新建项以输入名为“将标记添加到自述文件”—“问题（基本）”、“用户情景（敏捷）”或“产品积压工作项 (Scrum)”的新工作项，具体取决于 Azure Boards 项目使用的流程模型。

    标题为向自述文件添加标记的工作项随即显示在看板上。

  2. 打开工作项，转到开发部分，然后选择添加链接。

  3. 在 “链接类型”中，选择 “GitHub 拉取请求”。

  4. 选择该存储库，并输入拉取请求 ID 和可选注释。

  5. 选择“添加链接”。

    屏幕截图显示用户故事中的“添加链接”操作，其中显示了存储库选择，并有用于输入拉取请求 ID 和可选注释的空框。

    后台将自动执行以下操作：

    • 将标记添加到已连接 GitHub 存储库的列表中第一个存储库的自述文件。
    • 为通过将标记添加到自述文件而执行的更新创建 GitHub 提交。
    • 创建 GitHub 拉取请求以合并对自述文件所做的更改。
    • 将 GitHub 提交和拉取请求链接到步骤 1 中创建的工作项。

  6. 从工作项中选择第一个拉取请求链接。

    屏幕截图显示了 GitHub 中打开的拉取请求的问题表单。

    将在新的浏览器选项卡中打开 GitHub 拉取请求。

  7. 选择合并拉取请求。

    屏幕截图显示了 GitHub 中的示例拉取请求。

  8. 转到存储库自述文件并查看已添加的标记。

    屏幕截图显示了添加徽章的 GitHub 存储库。

    有关详细信息，请参阅 为 GitHub 存储库添加状态徽章。

配置其他项目或存储库

可以配置其他 Azure Boards/Azure DevOps Projects、GitHub.com 存储库，或从 Azure Boards 应用页更改当前配置。 有关详细信息，请参阅 添加或删除存储库，或者从 Azure Boards 中删除连接。

添加或删除存储库，或从 Azure Boards 中删除连接

如果遇到连接问题，建议删除连接，并重新开始创建新连接。

  1. 在 Azure DevOps 项目中，转到项目设置>GitHub 连接。

  2. 若要添加或删除存储库，请选择连接的更多操作省略号，然后从菜单中选择添加存储库或删除存储库。

    屏幕截图显示了“更多选项”的 GitHub 连接菜单。

  3. 若要删除所有存储库和连接，请选择删除连接选项。 然后，选择删除进行确认。

    屏幕截图显示了确认删除 GitHub 连接。

更改存储库访问

  1. 在 GitHub Web 门户中，从配置文件菜单打开设置。

  2. 选择 集成>应用程序。 在 “已安装的 GitHub 应用”下，选择“ 配置”。

    屏幕截图显示了“已安装的 GitHub 应用与 Azure Boards”和“配置”选项。

    此时会打开“Azure Boards 配置”页。

  3. 向下滚动到存储库访问权限部分。

  4. 选择所需选项所有存储库或仅选择存储库。

    如果选择仅选择存储库，请选择要参与与 Azure Boards 集成的存储库。

    屏幕截图显示了存储库访问权限，可在其中选择所选存储库。

  5. 选择“保存”。

暂停或卸载 Azure Boards 集成

  1. 从上一过程中的步骤 2 开始，向下滚动到危险区域部分。

    屏幕截图显示了“危险区域”部分，其中包含用于暂停和卸载的选项。

  2. 若要暂停集成，请选择暂停。 在确认窗口中，选择 “确定” 以确认暂停操作。

    屏幕截图显示了“暂停确认”对话框。

    若要取消暂停集成，请选择取消暂停。

  3. 若要卸载 Azure Boards 应用，请选择卸载，然后从确认弹出窗口中选择确定。

    屏幕截图显示了“卸载确认”对话框。

更新 Azure Boards-GitHub 连接

如果更改适用于 GitHub 的 Azure Boards 应用所支持的存储库，则可能会被重定向到 Azure Boards GitHub 连接。 一个好的做法是删除 Azure Boards 中无法再连接到 GitHub 的存储库。 有关详细信息，请参阅添加或删除 GitHub 存储库。

如果卸载适用于 GitHub 的 Azure Boards 应用，则会在 Azure Boards 内的项目设置>GitHub 连接中显示以下消息。 选择删除连接以删除所有以前建立的 GitHub 连接。 有关详细信息，请参阅添加或删除 GitHub 存储库。

屏幕截图显示了卸载的 Azure Boards GitHub 应用。

后续步骤

将 GitHub 提交、拉取请求和分支关联到工作项

相关内容