Skip to main content

管理合并队列

您可以通过存储库中拉取请求的合并队列来加快开发速度。

People with admin permissions can manage merge queues for pull requests targeting selected branches of a repository.

注意: 拉取请求合并队列功能目前处于有限公测阶段,可能会发生更改。

关于合并队列

合并队列可以提高将拉取请求合并到繁忙的目标分支中的速率,同时确保所有必需的分支保护检查都通过。

拉取请求通过所有必需的分支保护检查后,对存储库具有写入访问权限的用户可以将该拉取请求添加到合并队列中。

合并队列可以使用 GitHub Actions。 更多信息请参阅“GitHub Actions”。

合并队列创建具有特殊前缀的临时分支,以验证拉取请求更改。 The changes in the pull request are then grouped into a merge_group with the latest version of the base_branch as well as changes ahead of it in the queue. GitHub 将在 base_branch 的分支保护所需的检查通过后,将所有这些更改合并到 base_branch 中。

有关合并方法的信息,请参阅“关于拉取请求合并”。

注:

  • 不可对在分支名称模式中使用通配符 (*) 的分支保护规则启用合并队列。

将拉取请求与目标分支的最新版本分组并在队列中更改后,如果所需的状态检查失败或与基本分支发生冲突,GitHub 将从队列中删除拉取请求。 拉取请求时间线将显示从队列中删除拉取请求的原因。

Triggering merge group checks with GitHub Actions

You can use the merge_group event to trigger your GitHub Actions workflow when a pull request is added to a merge queue. Note that this is a different event from the pull_request and push events.

A workflow that reports a check which is required by the target branch's protections would look like this:

on:
  pull_request:
  merge_group:

For more information see "Events that trigger workflows"

Triggering merge group checks with other CI providers

With other CI providers, you may need to update your CI configuration to run when a branch that begins with the special prefix gh-readonly-queue/{base_branch} is created.

管理合并队列

存储库管理员可以通过在基本分支的保护规则中启用分支保护设置“需要合并队列”来要求合并。

有关如何启用合并队列保护设置的信息,请参阅“管理分支保护规则”。

延伸阅读