On1.3.0
- Known subtypes in package:
- Known usages in package:
- All versions:
Properties
-
-
expand_morelink
Runs your workflow anytime the check_run event occurs.
More than one activity type triggers this event.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#check_run
-
expand_morelink
Runs your workflow anytime the
check_suiteevent occurs.More than one activity type triggers this event.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#check_suite
-
expand_morelink
Runs your workflow anytime someone creates a branch or tag, which triggers the create event.
For information about the REST API, see https://developer.github.com/v3/git/refs/#create-a-reference.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#create
-
expand_morelink
Runs your workflow when someone deletes a Git reference (Git branch or tag) in the workflow's repository.
For information about the APIs to delete a Git reference, see Mutations in the GraphQL API documentation or REST API endpoints for Git references.
-
expand_morelink
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.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#deployment
-
expand_morelink
Runs your workflow anytime a third party provides a deployment status, which triggers the
deployment_statusevent.Deployments created with a commit SHA may not have a Git ref.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#deployment_status
-
expand_morelink
Runs your workflow anytime the discussion event occurs.
More than one activity type triggers this event.
See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#discussion
-
expand_morelink
Runs your workflow anytime the discussion_comment event occurs.
More than one activity type triggers this event.
-
expand_morelink
Runs your workflow anytime when someone forks a repository, which triggers the
forkevent. -
expand_morelink
Runs your workflow when someone creates or updates a Wiki page, which triggers the
gollumevent. -
expand_morelink
Runs your workflow anytime the
issue_commentevent occurs.More than one activity type triggers this event.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issue_comment
-
expand_morelink
Runs your workflow anytime the
issuesevent occurs.More than one activity type triggers this event.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#issues
-
expand_morelink
Runs your workflow anytime the
labelevent occurs.More than one activity type triggers this event.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#label
-
expand_morelink
Runs your workflow when a pull request is added to a merge queue, which adds the pull request to a merge group.
For information about the merge queue, see https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/merging-a-pull-request-with-a-merge-queue.
-
expand_morelink
Runs your workflow anytime the
milestoneevent occurs.More than one activity type triggers this event.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#milestone
-
expand_morelink
Runs your workflow anytime someone pushes to a GitHub Pages-enabled branch, which triggers the
page_buildevent. -
expand_morelink
Runs your workflow anytime the project event occurs.
More than one activity type triggers this event.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#project
-
expand_morelink
Runs your workflow anytime the
project_cardevent occurs.More than one activity type triggers this event.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#project_card
-
expand_morelink
Runs your workflow anytime the
project_columnevent occurs.More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/projects/columns.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#project_column
-
expand_morelink
Runs your workflow anytime someone makes a private repository public, which triggers the
publicevent.For information about the REST API, see https://developer.github.com/v3/repos/#edit.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#public
-
expand_morelink
Runs your workflow anytime the
pull_requestevent occurs.More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/pulls.
Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. When you create a pull request from a forked repository to the base repository, GitHub sends the
pull_requestevent 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 theGITHUB_TOKENin forked repositories is read-only. For more information about theGITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request
-
expand_morelink
Runs your workflow anytime the
pull_request_reviewevent occurs.More than one activity type triggers this event.
Note: Workflows do not run on private base repositories when you open a pull request from a forked repository. 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 about the GITHUB_TOKEN, see https://help.github.com/en/articles/virtual-environments-for-github-actions.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_review
-
expand_morelink
Runs your workflow anytime a comment on a pull request's unified diff is modified, which triggers the
pull_request_review_commentevent.More than one activity type triggers this event.
-
expand_morelink
This event is similar to
pull_request, except that it runs in the context of the base repository of the pull request, rather than in the merge commit.This means that you can more safely make your secrets available to the workflows triggered by the pull request, because only workflows defined in the commit on the base repository are run.
For example, this event allows you to create workflows that label and comment on pull requests, based on the contents of the event payload.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
-
expand_morelink
Runs your workflow when someone pushes to a repository branch, which triggers the
pushevent.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 https://developer.github.com/v3/repos/commits/#get-a-single-commit.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#push
-
-
expand_morelink
Runs your workflow anytime the release event occurs.
More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/repos/releases/ in the GitHub Developer documentation.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#release
-
expand_morelink
You can use the GitHub API to trigger a webhook event called
repository_dispatchwhen you want to trigger a workflow for activity that happens outside of GitHub.For more information, see https://developer.github.com/v3/repos/#create-a-repository-dispatch-event. To trigger the custom
repository_dispatchwebhook event, you must send a POST request to a GitHub API endpoint and provide anevent_typename to describe the activity type. To trigger a workflow run, you must also configure your workflow to use therepository_dispatchevent. -
expand_morelink
You can schedule a workflow to run at specific UTC times using POSIX cron syntax (https://pubs.opengroup.org/onlinepubs/9699919799/utilities/crontab.html#tag_20_25_07).
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. Note: GitHub Actions does not support the non-standard syntax @yearly, @monthly, @weekly, @daily, @hourly, and @reboot. You can use crontab guru (https://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 (https://crontab.guru/examples.html).
See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#schedule
-
expand_morelink
Runs your workflow anytime the status of a Git commit changes, which triggers the
statusevent.For information about the REST API, see https://developer.github.com/v3/repos/statuses/.
See https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#status
-
expand_morelink
Runs your workflow anytime the
watchevent occurs.More than one activity type triggers this event. For information about the REST API, see https://developer.github.com/v3/activity/starring/
See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#watch
-
-
expand_morelink
You can now create workflows that are manually triggered with the new
workflow_dispatchevent.You will then see a 'Run workflow' button on the Actions tab, enabling you to easily trigger a run.
-
expand_morelink
This event occurs when a workflow run is requested or completed, and allows you to execute a workflow based on the finished result of another workflow.
For example, if your
pull_requestworkflow generates build artifacts, you can create a new workflow that usesworkflow_runto analyze the results and add a comment to the original pull request.See https://docs.github.com/en/actions/learn-github-actions/events-that-trigger-workflows#workflow_run
Runs your workflow anytime the
branch_protection_ruleevent occurs.