Events that trigger workflows

About workflow events

You can configure your workflow to run when webhook events are created from activity on GitHub. Workflows can use more than one webhook event to trigger a workflow run. For more information, see "Webhooks" in the GitHub Developer documentation. For more information about the on syntax, see "Workflow syntax for GitHub Actions."

The following steps occur to trigger a workflow run:

1. An event occurs on your repository, and the resulting event webhook has an associated commit SHA and Git ref.

2. The .github/workflows directory in your repository is searched for workflow files at the associated commit SHA or Git ref. The workflow files must be present in that commit SHA or Git ref to be considered.

   For example, if the event occurred on a particular repository branch, then the workflow files must be present in the repository on that branch.

3. The workflow files for that commit SHA and Git ref are inspected, and a new workflow run is triggered for any workflows that have on: values that match the triggering event.

   The workflow runs on your repository's code at the same commit SHA and Git ref that triggered the event. When a workflow runs, GitHub sets the GITHUB_SHA (commit SHA) and GITHUB_REF (Git ref) environment variables in the runner environment. For more information, see "Using environment variables."

Example using a single event

# Trigger on push
on: push

Example using a list of events

# Trigger the workflow on push or pull request
on: [push, pull_request]

Example using multiple events with activity types or configuration

If you need to specify activity types or configuration for an event, you must configure each event separately. You must append a colon (:) to all events, including events without configuration.

on:
  # Trigger the workflow on push or pull request,
  # but only for the master branch
  push:
    branches:
      - master
  pull_request:
    branches:
      - master
  # Also trigger on page_build, as well as release created events
  page_build:
  release:
    types: # This configuration does not affect the page_build event above
      - created

Webhook events

You can configure your workflow to run when webhook events are created on GitHub. Some events have more than one activity type that triggers the event. If more than one activity type triggers the event, you can specify which activity types will trigger the workflow to run.

Check run event: check_run

Runs your workflow anytime the check_run event occurs. More than one activity type triggers this event. For information about the REST API, see "Check runs" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a check run has been rerequested or requested_action.

on:
  check_run:
    types: [rerequested, requested_action]

Check suite event: check_suite

Runs your workflow anytime the check_suite event occurs. More than one activity type triggers this event. For information about the REST API, see "Check suites" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a check suite has been rerequested or completed.

on:
  check_suite:
    types: [rerequested, completed]

Create event: create

Runs your workflow anytime someone creates a branch or tag, which triggers the create event. For information about the REST API, see "Create a reference" in the GitHub Developer documentation.

For example, you can run a workflow when the create event occurs.

on:
  create

Delete event: delete

Runs your workflow anytime someone deletes a branch or tag, which triggers the delete event. For information about the REST API, see "Delete a reference" in the GitHub Developer documentation.

For example, you can run a workflow when the delete event occurs.

on:
  delete

Deployment event: deployment

Runs your workflow anytime someone creates a deployment, which triggers the deployment event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "Deployments" in the GitHub Developer documentation.

For example, you can run a workflow when the deployment event occurs.

on:
  deployment

Deployment status event: deployment_status

Runs your workflow anytime a third party provides a deployment status, which triggers the deployment_status event. Deployments created with a commit SHA may not have a Git ref. For information about the REST API, see "Create a deployment status" in the GitHub Developer documentation.

For example, you can run a workflow when the deployment_status event occurs.

on:
  deployment_status

Fork event: fork

Runs your workflow anytime when someone forks a repository, which triggers the fork event. For information about the REST API, see "Create a fork" in the GitHub Developer documentation.

For example, you can run a workflow when the fork event occurs.

on:
  fork

Gollum event: gollum

Runs your workflow when someone creates or updates a Wiki page, which triggers the gollum event.

For example, you can run a workflow when the gollum event occurs.

on:
  gollum

Issue comment event: issue_comment

Runs your workflow anytime the issue_comment event occurs. More than one activity type triggers this event. For information about the REST API, see "Issue comments" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when an issue comment has been created or deleted.

on:
  issue_comment:
    types: [created, deleted]

Issues event: issues

Runs your workflow anytime the issues event occurs. More than one activity type triggers this event. For information about the REST API, see "Issues" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when an issue has been opened, edited, or milestoned.

on:
  issues:
    types: [opened, edited, milestoned]

Label event: label

Runs your workflow anytime the label event occurs. More than one activity type triggers this event. For information about the REST API, see "Labels" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a label has been created or deleted.

on:
  label:
    types: [created, deleted]

Milestone event: milestone

Runs your workflow anytime the milestone event occurs. More than one activity type triggers this event. For information about the REST API, see "Milestones" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a milestone has been opened or deleted.

on:
  milestone:
    types: [opened, deleted]

Page build event: page_build

Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the page_build event. For information about the REST API, see "Pages" in the GitHub Developer documentation.

For example, you can run a workflow when the page_build event occurs.

on:
  page_build

Project event: project

Runs your workflow anytime the project event occurs. More than one activity type triggers this event. For information about the REST API, see "Projects" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a project has been created or deleted.

on:
  project:
    types: [created, deleted]

Project card event: project_card

Runs your workflow anytime the project_card event occurs. More than one activity type triggers this event. For information about the REST API, see "Project cards" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a project card has been opened or deleted.

on:
  project_card:
    types: [opened, deleted]

Project column event: project_column

Runs your workflow anytime the project_column event occurs. More than one activity type triggers this event. For information about the REST API, see "Project columns" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a project column has been created or deleted.

on:
  project_column:
    types: [created, deleted]

Public event: public

Runs your workflow anytime someone makes a private repository public, which triggers the public event. For information about the REST API, see "Edit repositories" in the GitHub Developer documentation.

For example, you can run a workflow when the public event occurs.

on:
  public

Pull request event: pull_request

Runs your workflow anytime the pull_request event occurs. More than one activity type triggers this event. For information about the REST API, see "Pull requests" in the GitHub Developer documentation.

You extend or limit the default activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a pull request has been assigned, opened, synchronize, or reopened.

on:
  pull_request:
    types: [assigned, opened, synchronize, reopened]

Pull request events for forked repositories

When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.

Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.

The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information, see "Authenticating with the GITHUB_TOKEN."

Pull request review event: pull_request_review

Runs your workflow anytime the pull_request_review event occurs. More than one activity type triggers this event. For information about the REST API, see "Pull request reviews" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a pull request review has been edited or dismissed.

on:
  pull_request_review:
    types: [edited, dismissed]

Pull request events for forked repositories

When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.

Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.

The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information, see "Authenticating with the GITHUB_TOKEN."

Pull request review comment event: pull_request_review_comment

Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the pull_request_review_comment event. More than one activity type triggers this event. For information about the REST API, see Review comments in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a pull request review comment has been created or deleted.

on:
  pull_request_review_comment:
    types: [created, deleted]

Pull request events for forked repositories

When you create a pull request from a forked repository to the base repository, GitHub sends the pull_request event to the base repository and no pull request events occur on the forked repository.

Workflows don't run on forked repositories by default. You must enable GitHub Actions in the Actions tab of the forked repository.

The permissions for the GITHUB_TOKEN in forked repositories is read-only. For more information, see "Authenticating with the GITHUB_TOKEN."

Push event: push

Runs your workflow when someone pushes to a repository branch, which triggers the push event.

For example, you can run a workflow when the push event occurs.

on:
  push

Registry package event: registry_package

Runs your workflow anytime a package is published or updated. For more information, see "Managing packages with GitHub Packages."

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a package has been published.

on:
  registry_package:
    types: [published]

Release event: release

Runs your workflow anytime the release event occurs. More than one activity type triggers this event. For information about the REST API, see "Releases" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when a release has been published.

on:
  release:
    types: [published]

Status event: status

Runs your workflow anytime the status of a Git commit changes, which triggers the status event. For information about the REST API, see Statuses in the GitHub Developer documentation.

For example, you can run a workflow when the status event occurs.

on:
  status

Watch event: watch

Runs your workflow anytime the watch event occurs. More than one activity type triggers this event. For information about the REST API, see "Starring" in the GitHub Developer documentation.

By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword. For more information, see "Workflow syntax for GitHub Actions."

For example, you can run a workflow when someone stars a repository, which is the started activity type that triggers the watch event.

on:
  watch:
    types: [started]

Scheduled events: schedule

You can schedule a workflow to run at specific UTC times using POSIX cron syntax. Scheduled workflows run on the latest commit on the default or base branch. The shortest interval you can run scheduled workflows is once every 5 minutes.

This example triggers the workflow every 15 minutes:

on:
  schedule:
    # * is a special character in YAML so you have to quote this string
    - cron:  '*/15 * * * *'

Cron syntax has five fields separated by a space, and each field represents a unit of time.

┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of the month (1 - 31)
│ │ │ ┌───────────── month (1 - 12 or JAN-DEC)
│ │ │ │ ┌───────────── day of the week (0 - 6 or SUN-SAT)
│ │ │ │ │                                   
│ │ │ │ │
│ │ │ │ │
* * * * *

You can use these operators in any of the five fields:

You can use crontab guru to help generate your cron syntax and confirm what time it will run. To help you get started, there is also a list of crontab guru examples.

External events: repository_dispatch

You can use the GitHub API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of GitHub. For more information, see "Create a repository dispatch event" in the GitHub Developer documentation.

To trigger the custom repository_dispatch webhook event, you must send a POST request to a GitHub API endpoint and provide an event_type name to describe the activity type. To trigger a workflow run, you must also configure your workflow to use the repository_dispatch event.

Example

This event does not have additional activity types so it does not support the types keyword.

on: repository_dispatch

Triggering new workflows using a personal access token

When you use the repository's GITHUB_TOKEN to perform tasks on behalf of the GitHub Actions app, events triggered by the GITHUB_TOKEN will not create a new workflow run. This prevents you from accidentally creating recursive workflow runs. For example, if a workflow run pushes code using the repository's GITHUB_TOKEN, a new workflow will not run even when the repository contains a workflow configured to run when push events occur. For more information, see "Authenticating with the GITHUB_TOKEN."

If you would like to trigger a workflow from a workflow run, you can trigger the event using a personal access token. You'll need to create a personal access token and store it as a secret in your repository. To minimize your GitHub Actions usage costs, ensure that you don't create recursive or unintended workflow runs. For more information, see "Creating and storing encrypted secrets."