About events that trigger workflows
Workflow triggers are events that cause a workflow to run. For more information about how to use workflow triggers, see "Triggering a workflow."
Available events
Some events have multiple activity types. For these events, you can specify which activity types will trigger a workflow run. For more information about what each activity type means, see "Webhook events and payloads." Note that not all webhook events trigger workflows.
check_run
| Webhook event payload | Activity types | GITHUB_SHA | GITHUB_REF |
|---|---|---|---|
check_run | - created- rerequested- completed- requested_action | Last commit on default branch | Default branch |
Note: More than one activity type triggers this event. 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."
Note: This event will only trigger a workflow run if the workflow file is on the default branch.
Runs your workflow when activity related to a check run occurs. A check run is an individual test that is part of a check suite. For information, see "Getting started with the Checks API." For information about the check run APIs, see "CheckRun" in the GraphQL API documentation or "Checks" in the REST API documentation.
For example, you can run a workflow when a check run has been rerequested or completed.
on:
check_run:
types: [rerequested, completed]
check_suite
| Webhook event payload | Activity types | GITHUB_SHA | GITHUB_REF |
|---|---|---|---|
check_suite | - completed | Last commit on default branch | Default branch |
Note: More than one activity type triggers this event. For information about each activity type, see "Webhook events and payloads." Although only the started activity type is supported, specifying the activity type will keep your workflow specific if more activity types are added in the future. 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."
Note: This event will only trigger a workflow run if the workflow file is on the default branch.
Note: To prevent recursive workflows, this event does not trigger workflows if the check suite was created by GitHub Actions.
Runs your workflow when check suite activity occurs. A check suite is a collection of the check runs created for a specific commit. Check suites summarize the status and conclusion of the check runs that are in the suite. For information, see "Getting started with the Checks API." For information about the check suite APIs, see "CheckSuite" in the GraphQL API documentation or "Checks" in the REST API documentation.
For example, you can run a workflow when a check suite has been completed.
on:
check_suite:
types: [completed]
create
| Webhook event payload | Activity types | GITHUB_SHA | GITHUB_REF |
|---|---|---|---|
create | n/a |