Skip to content

Document on.merge_group branches and branches-ignore filters (#32879) #45547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
sudorm-rf0 wants to merge 2 commits into
base: main
Choose a base branch
from
+20 −2
Open

Document on.merge_group branches and branches-ignore filters (#32879) #45547

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5b45039
Document on.merge_group branches and branches-ignore filters
sudorm-rf0 Aug 19, 2026
4b9a4bc
Fix consecutive blank lines (markdownlint MD012)
sudorm-rf0 Aug 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 20 additions & 2 deletions content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -394,6 +394,26 @@ on:
types: [checks_requested]
```

You can use the `branches` and `branches-ignore` filters with `merge_group` to only run a workflow when the merge group targets specific branches. For more information, see [AUTOTITLE](/actions/reference/workflows-and-actions/workflow-syntax#onpull_requestpull_request_targetbranchesbranches-ignore).

For example, you can run a workflow only when the merge group targets the `main` branch.

```yaml
on:
merge_group:
branches: [ "main" ]
types: [checks_requested]
```

You can also use `branches-ignore` to skip a specific branch.

```yaml
on:
merge_group:
branches-ignore: [ "main" ]
types: [checks_requested]
```

## `milestone`

| Webhook event payload | Activity types | `GITHUB_SHA` | `GITHUB_REF` |
Expand Down Expand Up @@ -1278,5 +1298,3 @@ jobs:
body: 'Thank you for the PR!'
});
```


Loading