docs/content/actions/reference/events-that-trigger-workflows.md at a8524638ad901b2bb77eea0ddd94a30706ff71ec

jprdonnelly/docs

Fork 0

mirror of synced 2025-12-23 03:44:00 -05:00

Files

Gina Häußge cfe2e819f3 Clarify release event trigger behaviour (#5769 )

2021-04-27 18:12:27 +00:00

36 KiB

Raw Blame History

title, intro, product, miniTocMaxHeadingLevel, redirect_from, versions

title

intro

product

miniTocMaxHeadingLevel

redirect_from

versions

Events that trigger workflows

You can configure your workflows to run when specific activity on {% data variables.product.product_name %} happens, at a scheduled time, or when an event outside of {% data variables.product.product_name %} occurs.

{% data reusables.gated-features.actions %}

/articles/events-that-trigger-workflows

/github/automating-your-workflow-with-github-actions/events-that-trigger-workflows

/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows

free-pro-team	enterprise-server	github-ae
*	>=2.22	*

{% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} {% data reusables.actions.ae-beta %}

Configuring workflow events

You can configure workflows to run for one or more events using the on workflow syntax. For more information, see "Workflow syntax for {% data variables.product.prodname_actions %}."

{% data reusables.github-actions.actions-on-examples %}

{% note %}

Note: You cannot trigger new workflow runs using the GITHUB_TOKEN. For more information, see "Triggering new workflows using a personal access token."

{% endnote %}

The following steps occur to trigger a workflow run:

An event occurs on your repository, and the resulting event has an associated commit SHA and Git ref.
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.

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, {% data variables.product.product_name %} sets the GITHUB_SHA (commit SHA) and GITHUB_REF (Git ref) environment variables in the runner environment. For more information, see "Using environment variables."

Scheduled events

The schedule event allows you to trigger a workflow at a scheduled time.

{% data reusables.actions.schedule-delay %}

`schedule`

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
n/a	n/a	Last commit on default branch	Default branch

{% data reusables.repositories.actions-scheduled-workflow-example %}

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:

Operator	Description	Example
*	Any value	`* * * * *` runs every minute of every day.
,	Value list separator	`2,10 4,5 * * *` runs at minute 2 and 10 of the 4th and 5th hour of every day.
-	Range of values	`0 4-6 * * *` runs at minute 0 of the 4th, 5th, and 6th hour.
/	Step values	`20/15 * * * *` runs every 15 minutes starting from minute 20 through 59 (minutes 20, 35, and 50).

{% note %}

Note: {% data variables.product.prodname_actions %} does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot.

{% endnote %}

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.

Notifications for scheduled workflows are sent to the user who last modified the cron syntax in the workflow file. For more information, please see "Notifications for workflow runs."

Manual events

You can manually trigger workflow runs. To trigger specific workflows in a repository, use the workflow_dispatch event. To trigger more than one workflow in a repository and create custom events and event types, use the repository_dispatch event.

`workflow_dispatch`

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
workflow_dispatch	n/a	Last commit on the `GITHUB_REF` branch	Branch that received dispatch

You can configure custom-defined input properties, default input values, and required inputs for the event directly in your workflow. When the workflow runs, you can access the input values in the github.event.inputs context. For more information, see "Context and expression syntax for {% data variables.product.prodname_actions %}."

You can manually trigger a workflow run using the {% data variables.product.product_name %} API and from {% data variables.product.product_name %}. For more information, see "Manually running a workflow."

When you trigger the event on {% data variables.product.prodname_dotcom %}, you can provide the ref and any inputs directly on {% data variables.product.prodname_dotcom %}. For more information, see "Using inputs and outputs with an action."

To trigger the custom workflow_dispatch webhook event using the REST API, you must send a POST request to a {% data variables.product.prodname_dotcom %} API endpoint and provide the ref and any required inputs. For more information, see the "Create a workflow dispatch event" REST API endpoint.

Example

To use the workflow_dispatch event, you need to include it as a trigger in your GitHub Actions workflow file. The example below only runs the workflow when it's manually triggered:

on: workflow_dispatch

Example workflow configuration

This example defines the name and home inputs and prints them using the github.event.inputs.name and github.event.inputs.home contexts. If a home isn't provided, the default value 'The Octoverse' is printed.

{% raw %}

name: Manually triggered workflow
on:
  workflow_dispatch:
    inputs:
      name:
        description: 'Person to greet'
        required: true
        default: 'Mona the Octocat'
      home:
        description: 'location'
        required: false
        default: 'The Octoverse'

jobs:
  say_hello:
    runs-on: ubuntu-latest
    steps:
    - run: |
        echo "Hello ${{ github.event.inputs.name }}!"
        echo "- in ${{ github.event.inputs.home }}!"

{% endraw %}

`repository_dispatch`

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
repository_dispatch	n/a	Last commit on default branch	Default branch

{% data reusables.github-actions.branch-requirement %}

You can use the {% data variables.product.product_name %} API to trigger a webhook event called repository_dispatch when you want to trigger a workflow for activity that happens outside of {% data variables.product.prodname_dotcom %}. For more information, see "Create a repository dispatch event."

To trigger the custom repository_dispatch webhook event, you must send a POST request to a {% data variables.product.product_name %} 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

By default, all event_types trigger a workflow to run. You can limit your workflow to run when a specific event_type value is sent in the repository_dispatch webhook payload. You define the event types sent in the repository_dispatch payload when you create the repository dispatch event.

on:
  repository_dispatch:
    types: [opened, deleted]

Webhook events

You can configure your workflow to run when webhook events are generated on {% data variables.product.product_name %}. 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. For more information, see "Webhooks."

Not all webhook events trigger workflows. For the complete list of available webhook events and their payloads, see "Webhook events and payloads."

`check_run`

Runs your workflow anytime the check_run event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Check runs."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`check_run`	- `created` - `rerequested` - `completed` - `requested_action`	Last commit on default branch	Default branch

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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`

Runs your workflow anytime the check_suite event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Check suites."

{% data reusables.github-actions.branch-requirement %}

{% note %}

Note: To prevent recursive workflows, this event does not trigger workflows if the check suite was created by {% data variables.product.prodname_actions %}.

{% endnote %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`check_suite`	- `completed` - `requested` - `rerequested`	Last commit on default branch	Default branch

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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

on:
  check_suite:
    types: [rerequested, completed]

`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."

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`create`	n/a	Last commit on the created branch or tag	Branch or tag created

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

on:
  create

`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."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`delete`	n/a	Last commit on default branch	Default branch

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

on:
  delete

`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."

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`deployment`	n/a	Commit to be deployed	Branch or tag to be deployed (empty if commit)

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

on:
  deployment

`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."

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`deployment_status`	n/a	Commit to be deployed	Branch or tag to be deployed (empty if commit)

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

on:
  deployment_status

{% note %}

Note: When a deployment status's state is set to inactive, a webhook event will not be created.

{% endnote %}

`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."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`fork`	n/a	Last commit on default branch	Default branch

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

on:
  fork

`gollum`

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

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`gollum`	n/a	Last commit on default branch	Default branch

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

on:
  gollum

`issue_comment`

Runs your workflow anytime the issue_comment event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Issue comments."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`issue_comment`	- `created` - `edited` - `deleted`	Last commit on default branch	Default branch

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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

on:
  issue_comment:
    types: [created, deleted]

The issue_comment event occurs for comments on both issues and pull requests. To determine whether the issue_comment event was triggered from an issue or pull request, you can check the event payload for the issue.pull_request property and use it as a condition to skip a job.

For example, you can choose to run the pr_commented job when comment events occur in a pull request, and the issue_commented job when comment events occur in an issue.

{% raw %}

on: issue_comment

jobs:
  pr_commented:
    # This job only runs for pull request comments
    name: PR comment
    if: ${{ github.event.issue.pull_request }}
    runs-on: ubuntu-latest
    steps:
      - run: |
          echo "Comment on PR #${{ github.event.issue.number }}"

  issue_commented:
    # This job only runs for issue comments
    name: Issue comment
    if: ${{ !github.event.issue.pull_request }}
    runs-on: ubuntu-latest
    steps:
      - run: |
          echo "Comment on issue #${{ github.event.issue.number }}"

{% endraw %}

`issues`

Runs your workflow anytime the issues event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Issues."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`issues`	- `opened` - `edited` - `deleted` - `transferred` - `pinned` - `unpinned` - `closed` - `reopened` - `assigned` - `unassigned` - `labeled` - `unlabeled` - `locked` - `unlocked` - `milestoned` - `demilestoned`	Last commit on default branch	Default branch

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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

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

`label`

Runs your workflow anytime the label event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Labels."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`label`	- `created` - `edited` - `deleted`	Last commit on default branch	Default branch

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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

on:
  label:
    types: [created, deleted]

`milestone`

Runs your workflow anytime the milestone event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Milestones."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`milestone`	- `created` - `closed` - `opened` - `edited` - `deleted`	Last commit on default branch	Default branch

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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

on:
  milestone:
    types: [opened, deleted]

`page_build`

Runs your workflow anytime someone pushes to a {% data variables.product.product_name %} Pages-enabled branch, which triggers the page_build event. For information about the REST API, see "Pages."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`page_build`	n/a	Last commit on default branch	n/a

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

on:
  page_build

`project`

Runs your workflow anytime the project event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Projects."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`project`	- `created` - `updated` - `closed` - `reopened` - `edited` - `deleted`	Last commit on default branch	Default branch

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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

on:
  project:
    types: [created, deleted]

`project_card`

Runs your workflow anytime the project_card event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Project cards."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`project_card`	- `created` - `moved` - `converted` to an issue - `edited` - `deleted`	Last commit on default branch	Default branch

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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

on:
  project_card:
    types: [opened, deleted]

`project_column`

Runs your workflow anytime the project_column event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Project columns."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`project_column`	- `created` - `updated` - `moved` - `deleted`	Last commit on default branch	Default branch

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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

on:
  project_column:
    types: [created, deleted]

`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."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`public`	n/a	Last commit on default branch	Default branch

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

on:
  public

`pull_request`

Runs your workflow anytime the pull_request event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Pull requests."

{% note %}

Note: By default, a workflow only runs when a pull_request's activity type is opened, synchronize, or reopened. To trigger workflows for more activity types, use the types keyword.

{% endnote %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`pull_request`	- `assigned` - `unassigned` - `labeled` - `unlabeled` - `opened` - `edited` - `closed` - `reopened` - `synchronize` - `ready_for_review` - `locked` - `unlocked` - `review_requested` - `review_request_removed`	Last merge commit on the `GITHUB_REF` branch	PR merge branch `refs/pull/:prNumber/merge`

You extend or limit the default activity types using the types keyword. For more information, see "Workflow syntax for {% data variables.product.prodname_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]

{% data reusables.developer-site.pull_request_forked_repos_link %}

`pull_request_review`

Runs your workflow anytime the pull_request_review event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Pull request reviews."

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`pull_request_review`	- `submitted` - `edited` - `dismissed`	Last merge commit on the `GITHUB_REF` branch	PR merge branch `refs/pull/:prNumber/merge`

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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

on:
  pull_request_review:
    types: [edited, dismissed]

{% data reusables.developer-site.pull_request_forked_repos_link %}

`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. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see Review comments.

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`pull_request_review_comment`	- `created` - `edited` - `deleted`	Last merge commit on the `GITHUB_REF` branch	PR merge branch `refs/pull/:prNumber/merge`

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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]

{% data reusables.developer-site.pull_request_forked_repos_link %}

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}

`pull_request_target`

This event runs in the context of the base of the pull request, rather than in the merge commit as the pull_request event does. This prevents executing unsafe workflow code from the head of the pull request that could alter your repository or steal any secrets you use in your workflow. This event allows you to do things like create workflows that label and comment on pull requests based on the contents of the event payload.

{% warning %}

Warning: The pull_request_target event is granted a read/write repository token and can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch, and to help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. For more information, see "Keeping your GitHub Actions and workflows secure: Preventing pwn requests" on the GitHub Security Lab website.

{% endwarning %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`pull_request_target`	- `assigned` - `unassigned` - `labeled` - `unlabeled` - `opened` - `edited` - `closed` - `reopened` - `synchronize` - `ready_for_review` - `locked` - `unlocked` - `review_requested` - `review_request_removed`	Last commit on the PR base branch	PR base branch

By default, a workflow only runs when a pull_request_target's activity type is opened, synchronize, or reopened. To trigger workflows for more activity types, use the types keyword. For more information, see "Workflow syntax for {% data variables.product.prodname_actions %}."

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

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

{% endif %}

`push`

{% note %}

Note: The webhook payload available to GitHub Actions does not include the added, removed, and modified attributes in the commit object. You can retrieve the full commit object using the REST API. For more information, see "Get a commit".

{% endnote %}

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

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`push`	n/a	Commit pushed, unless deleting a branch (when it's the default branch)	Updated ref

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

on:
  push

`registry_package`

Runs your workflow anytime a package is published or updated. For more information, see "Managing packages with {% data variables.product.prodname_registry %}."

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`registry_package`	- `published` - `updated`	Commit of the published package	Branch or tag of the published package

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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

on:
  registry_package:
    types: [published]

`release`

{% note %}

Note: The release event is not triggered for draft releases.

{% endnote %}

Runs your workflow anytime the release event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Releases."

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`release`	- `published` - `unpublished` - `created` - `edited` - `deleted` - `prereleased` - `released`	Last commit in the tagged release	Tag of release

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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

on:
  release:
    types: [published]

{% note %}

Note: The prereleased type will not trigger for pre-releases published from draft releases, but the published type will trigger. If you want a workflow to run when stable and pre-releases publish, subscribe to published instead of released and prereleased.

{% endnote %}

`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.

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`status`	n/a	Last commit on default branch	n/a

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

on:
  status

`watch`

Runs your workflow anytime the watch event occurs. {% data reusables.developer-site.multiple_activity_types %} For information about the REST API, see "Starring."

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`watch`	- `started`	Last commit on default branch	Default branch

{% data reusables.developer-site.limit_workflow_to_activity_types %}

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]

{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}

`workflow_run`

{% data reusables.webhooks.workflow_run_desc %}

{% data reusables.github-actions.branch-requirement %}

Webhook event payload	Activity types	`GITHUB_SHA`	`GITHUB_REF`
`workflow_run`	- `completed` - `requested`	Last commit on default branch	Default branch

{% data reusables.developer-site.limit_workflow_to_activity_types %}

If you need to filter branches from this event, you can use branches or branches-ignore.

In this example, a workflow is configured to run after the separate "Run Tests" workflow completes.

on:
  workflow_run:
    workflows: ["Run Tests"]
    branches: [main]
    types: 
      - completed
      - requested

{% endif %}

To run a workflow job conditionally based on the result of the previous workflow run, you can use the jobs.<job_id>.if or jobs.<job_id>.steps[*].if conditional combined with the conclusion of the previous run. For example:

on:
  workflow_run:
    workflows: ["Build"]
    types: [completed]

jobs:
  on-success:
    runs-on: ubuntu-latest
    if: {% raw %}${{ github.event.workflow_run.conclusion == 'success' }}{% endraw %}
    steps:
      ...
  on-failure:
    runs-on: ubuntu-latest
    if: {% raw %}${{ github.event.workflow_run.conclusion == 'failure' }}{% endraw %}
    steps:
      ...

Triggering new workflows using a personal access token

{% data reusables.github-actions.actions-do-not-trigger-workflows %} 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. To minimize your {% data variables.product.prodname_actions %} usage costs, ensure that you don't create recursive or unintended workflow runs. For more information on storing a personal access token as a secret, see "Creating and storing encrypted secrets."

36 KiB Raw Blame History

Configuring workflow events

Scheduled events

schedule

Manual events

workflow_dispatch

Example

Example workflow configuration

repository_dispatch

Example

Webhook events

check_run

check_suite

create

delete

deployment

deployment_status

fork

gollum

issue_comment

issues

label

milestone

page_build

project

project_card

project_column

public

pull_request

pull_request_review

pull_request_review_comment

pull_request_target

push

registry_package

release

status

watch

workflow_run

Triggering new workflows using a personal access token

36 KiB

Raw Blame History

`schedule`

`workflow_dispatch`

`repository_dispatch`

`check_run`

`check_suite`

`create`

`delete`

`deployment`

`deployment_status`

`fork`

`gollum`

`issue_comment`

`issues`

`label`

`milestone`

`page_build`

`project`

`project_card`

`project_column`

`public`

`pull_request`

`pull_request_review`

`pull_request_review_comment`

`pull_request_target`

`push`

`registry_package`

`release`

`status`

`watch`

`workflow_run`