为外部服务配置分支策略

  • 项目

Azure DevOps Services | Azure DevOps Server 2020 | Azure DevOps Server 2019 | TFS 2018

分支策略是一项功能强大的功能，通过为所有拉取请求建立要求来确保存储库中的高质量代码。 外部服务可以使用 PR 状态 API 将详细状态发布到 PR。 外部服务的分支策略使第三方服务能够参与 PR 工作流并建立策略要求。 本文指导你完成为发布 PR 状态的服务配置分支策略的过程。 有关 PR 状态的详细信息，请参阅 使用拉取请求状态自定义和扩展拉取请求工作流。

注意

本文中所述的功能需要 TFS 2018 Update 2 或更高版本。

先决条件

  • 包含 Git 存储库的 Azure DevOps 中的组织。 如果没有组织， 请注册 以免费无限制的专用 Git 存储库上传和共享代码。
  • 向 PR 发布状态的服务。 请参阅 创建拉取请求状态服务器。

配置分支策略

  1. 导航到 CodeBranches>，找到想要 (在通常main或develop) 上配置策略的分支。 在上下文菜单中，选择 “分支策略 ”选项。

    Select Branch policies from the context menu

  2. 向下滚动以查找 状态检查。 选择 + 按钮。

    Select the Add policy button

  3. 从列表中选择要为其创建策略的服务。 如果以前发布过状态，可以从列表中选择它;如果它是新策略，则可以键入策略的名称。

    Select the policy from the list

    • 策略要求 确定此策略是可选的，还是需要完成拉取请求到分支。
    • 授权标识 用于仅将指定标识中的状态计入策略履行。
    • 重置条件 用于确定发布状态何时不再有效。 如果发布的状态特定于最新代码 (，即生成) ，请在源分支发生 更改时检查重置状态 。
    • （可选）设置 路径筛选器。 详细了解分支策略中的 路径筛选器 。
    • 策略适用性 确定此策略是在创建拉取请求后立即应用的，还是策略仅在将第一个状态发布到拉取请求后才适用。
    • 默认显示名称 允许指定策略的可选显示名称。

创建新的拉取请求

  1. 在定义策略的分支中创建新的拉取请求。 有关详细信息，请参阅 创建拉取请求。

  2. 创建 PR 后，新策略将显示在 PR 详细信息视图的“策略”部分中。 最初，在外部服务发布状态之前，策略将显示为未设置。

    Policy status is visible in the Policies section

    服务发布状态后，策略将相应地更新。 在策略批准 PR 之前，将阻止完成。

    Policy status updates

    当满足策略条件并且服务发布 succeeded 状态时，PR 将得到批准，并取消阻止完成。

    Policy status approved and completion unblocked

总结

本文介绍了如何为外部服务配置分支策略。