This feature is available to repositories enrolled in the Pull Request Merge Queue beta.
A new webhook event and GitHub Actions workflow trigger (
merge_group) makes it easier to run required status checks on merge groups created by merge queue. A merge group includes the changes from one or more pull requests and must pass the status checks required by the target branch.
merge_group webhook event, which currently has one supported action (
checks_requested), is sent after a merge group is created and informs receivers, including GitHub Actions, when status checks are needed on the merge group. The event payload includes
head_sha, the commit SHA that should be validated and have status reported on using check runs or commit statuses. For GitHub Actions, status is reported automatically at the conclusion of jobs in the triggered workflow.
To trigger a GitHub Actions workflow for a merge group, the
merge_group trigger should be used. The following example triggers on individual pull requests and merge groups targeting the
# Trigger this workflow on individual pull requests and merge groups that target the `main` branch on: pull_request: branches: [ main ] merge_group: branches: [ main ]
push event is still sent when a merge group branch is created, and will trigger a GitHub Actions workflow. However, unlike a
merge_group event, a
push event does not include the target branch of the merge group.
Learn more about using merge queue.