This page was generated based on Github’s Documentation. See our welcome page for context and details.

Github Event `merge_group` #

Github Action Trigger #

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`merge_group`	`checks_requested`	SHA of the merge group	Ref of the merge group

Note: More than one activity type triggers this event. Although only the checks_requested activity type is supported, specifying the activity type will keep your workflow specific if more activity types are added in the future. For information about each activity type, see “Webhook events and payloads.” By default, all activity types trigger workflows that run on this event. You can limit your workflow runs to specific activity types using the types keyword. For more information, see “Workflow syntax for GitHub Actions.”

Runs your workflow when a pull request is added to a merge queue, which adds the pull request to a merge group. For more information see “Merging a pull request with a merge queue”.

For example, you can run a workflow when the checks_requested activity has occurred.

on:
  merge_group:
    types: [checks_requested]

Event Payload #

source

Activities: checks_requested, destroyed

Common Fields #

These fields are common to every event types available with this trigger.

field	type	required	description
`github.event.installation`	object	optional	The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App. For more information, see “Using webhooks with GitHub Apps."
`github.event.merge_group`	object	required	A group of pull requests that the merge queue has grouped together to be merged.
`github.event.merge_group.head_sha`	string	required	The SHA of the merge group.
`github.event.merge_group.head_ref`	string	required	The full ref of the merge group.
`github.event.merge_group.base_sha`	string	required	The SHA of the merge group’s parent commit.
`github.event.merge_group.base_ref`	string	required	The full ref of the branch the merge group will be merged into.
`github.event.merge_group.head_commit`	object	required	A commit.
`github.event.merge_group.head_commit.id`	string	required	SHA for the commit
`github.event.merge_group.head_commit.tree_id`	string	required	SHA for the commit’s tree
`github.event.merge_group.head_commit.message`	string	required	Message describing the purpose of the commit
`github.event.merge_group.head_commit.timestamp`	string	required	Timestamp of the commit
`github.event.merge_group.head_commit.author`	object or null	required	Information about the Git author
`github.event.merge_group.head_commit.author.name`	string	required	Name of the commit’s author
`github.event.merge_group.head_commit.author.email`	string	required	Git email address of the commit’s author
`github.event.merge_group.head_commit.committer`	object or null	required	Information about the Git committer
`github.event.merge_group.head_commit.committer.name`	string	required	Name of the commit’s committer
`github.event.merge_group.head_commit.committer.email`	string	required	Git email address of the commit’s committer
`github.event.organization`	object	optional	A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an organization.
`github.event.repository`	object	optional	The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository.
`github.event.sender`	object	optional	The GitHub user that triggered the event. This property is included in every webhook payload.

`checks_requested` #

This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "Managing a merge queue."

To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission.

field	type	required	description
`github.event.action`	`checks_requested`	required

`destroyed` #