{"id":47183,"date":"2024-10-04T06:05:06","date_gmt":"2024-10-04T06:05:06","guid":{"rendered":"https:\/\/www.devopsschool.com\/blog\/?p=47183"},"modified":"2024-10-04T06:05:06","modified_gmt":"2024-10-04T06:05:06","slug":"github-actioon-list-of-events-that-trigger-workflows","status":"publish","type":"post","link":"https:\/\/www.devopsschool.com\/blog\/github-actioon-list-of-events-that-trigger-workflows\/","title":{"rendered":"Github Actioon: List of Events that trigger workflows"},"content":{"rendered":"\n

GitHub Actions Events Table<\/strong><\/h3>\n\n\n\n
Event<\/strong><\/th>Description<\/strong><\/th>Common Use Cases<\/strong><\/th><\/tr><\/thead>
push<\/code><\/strong><\/td>Triggered when commits are pushed to a repository branch.<\/td>Run CI builds, deploy code, run tests, or linting after code is pushed to a branch.<\/td><\/tr>
pull_request<\/code><\/strong><\/td>Triggered when a pull request is opened, synchronized, or closed.<\/td>Run tests, build previews, and lint code when a pull request is created or updated.<\/td><\/tr>
pull_request_review<\/code><\/strong><\/td>Triggered when someone submits a review to a pull request.<\/td>Notify team members or run workflows based on PR reviews.<\/td><\/tr>
pull_request_review_comment<\/code><\/strong><\/td>Triggered when a comment is added to a pull request review.<\/td>Automate responses or actions based on review comments on pull requests.<\/td><\/tr>
workflow_dispatch<\/code><\/strong><\/td>Allows manually triggering a workflow via the GitHub Actions interface.<\/td>Trigger workflows manually, often used for custom workflows like deployments or tests.<\/td><\/tr>
schedule<\/code><\/strong><\/td>Triggered based on a cron schedule (e.g., daily, weekly).<\/td>Run periodic tasks like nightly builds, backups, or maintenance tasks.<\/td><\/tr>
release<\/code><\/strong><\/td>Triggered when a release is published, edited, or deleted.<\/td>Automatically deploy, notify teams, or create release notes when a new release is created.<\/td><\/tr>
issue_comment<\/code><\/strong><\/td>Triggered when a comment is added to an issue or pull request.<\/td>Respond to comments, automate issue management, or trigger builds\/tests based on comments.<\/td><\/tr>
issues<\/code><\/strong><\/td>Triggered when an issue is opened, edited, labeled, or closed.<\/td>Automate issue triaging, labeling, or closing stale issues.<\/td><\/tr>
create<\/code><\/strong><\/td>Triggered when a branch or tag is created.<\/td>Notify teams, or trigger CI\/CD workflows when new branches\/tags are created.<\/td><\/tr>
delete<\/code><\/strong><\/td>Triggered when a branch or tag is deleted.<\/td>Clean up resources or notify teams when a branch or tag is removed.<\/td><\/tr>
fork<\/code><\/strong><\/td>Triggered when a repository is forked.<\/td>Send a notification or log repository forks for tracking.<\/td><\/tr>
star<\/code><\/strong><\/td>Triggered when a repository is starred or unstarred.<\/td>Send a thank-you message or track the repository\u2019s popularity.<\/td><\/tr>
watch<\/code><\/strong><\/td>Triggered when someone starts watching the repository.<\/td>Notify maintainers or track the repository’s watchers.<\/td><\/tr>
public<\/code><\/strong><\/td>Triggered when a repository is made public.<\/td>Notify teams or trigger security workflows when a repository\u2019s visibility changes.<\/td><\/tr>
workflow_run<\/code><\/strong><\/td>Triggered by the completion of another workflow.<\/td>Chain workflows together, such as triggering deployments after a successful test run.<\/td><\/tr>
workflow_call<\/code><\/strong><\/td>Triggered when a reusable workflow is called from another workflow.<\/td>Allows reusability of workflows across repositories.<\/td><\/tr>
status<\/code><\/strong><\/td>Triggered when the status of a GitHub check run changes (e.g., success, failure).<\/td>Notify teams or execute follow-up actions based on the status of previous checks.<\/td><\/tr>
check_run<\/code><\/strong><\/td>Triggered when a check run (e.g., CI test) is created, completed, or updated.<\/td>Trigger workflows based on the results of automated checks.<\/td><\/tr>
check_suite<\/code><\/strong><\/td>Triggered when a check suite (collection of check runs) is requested or completed.<\/td>Perform actions based on the aggregate results of check suites.<\/td><\/tr>
repository_dispatch<\/code><\/strong><\/td>Triggered when an external service or another workflow sends a repository_dispatch<\/code> event.<\/td>Trigger workflows from external systems or via API requests.<\/td><\/tr>
deployment<\/code><\/strong><\/td>Triggered when a deployment is created.<\/td>Automate deployment processes like deploying applications or setting up infrastructure.<\/td><\/tr>
deployment_status<\/code><\/strong><\/td>Triggered when a deployment status is updated (e.g., success, failure).<\/td>Perform actions like rollback or notification based on the outcome of a deployment.<\/td><\/tr>
pull_request_target<\/code><\/strong><\/td>Triggered for pull requests targeting the repository, but runs in the context of the base branch.<\/td>Useful for workflows involving forked repositories, maintaining security while allowing PR contributions.<\/td><\/tr>
branch_protection_rule<\/code><\/strong><\/td>Triggered when a branch protection rule is added, edited, or deleted.<\/td>Monitor or enforce branch protection changes.<\/td><\/tr>
discussion<\/code><\/strong><\/td>Triggered when a discussion is created, edited, or deleted.<\/td>Automate discussion management, notify teams, or categorize discussions.<\/td><\/tr>
discussion_comment<\/code><\/strong><\/td>Triggered when a comment is added to a discussion.<\/td>Automate responses or notifications based on discussion comments.<\/td><\/tr>
repository_vulnerability_alert<\/code><\/strong><\/td>Triggered when GitHub detects a security vulnerability in the repository.<\/td>Automate security workflows, patch dependencies, or notify security teams.<\/td><\/tr>
package<\/code><\/strong><\/td>Triggered when a package is published or updated.<\/td>Automate tasks like deployment or testing when a new package is released.<\/td><\/tr>
push_tag<\/code><\/strong><\/td>Triggered when a tag is pushed to the repository.<\/td>Use for versioning, release automation, or CI based on tagging.<\/td><\/tr>
milestone<\/code><\/strong><\/td>Triggered when a milestone is created, edited, or closed.<\/td>Automate milestone tracking or notify teams of milestone progress.<\/td><\/tr>
label<\/code><\/strong><\/td>Triggered when a label is created, edited, or deleted.<\/td>Automate label management for issues and pull requests.<\/td><\/tr>
registry_package<\/code><\/strong><\/td>Triggered when a registry package is published, updated, or deleted.<\/td>Manage or monitor changes in packages stored in GitHub\u2019s registry.<\/td><\/tr>
page_build<\/code><\/strong><\/td>Triggered when a GitHub Pages site build completes.<\/td>Automate tasks like notifying teams or triggering follow-up actions after a site is built.<\/td><\/tr>
member<\/code><\/strong><\/td>Triggered when a user is added, removed, or invited to a repository.<\/td>Automate onboarding or offboarding workflows for team members.<\/td><\/tr>
team<\/code><\/strong><\/td>Triggered when a team is added, modified, or deleted.<\/td>Automate team management workflows.<\/td><\/tr>
workflow_call<\/code><\/strong><\/td>Triggered when another workflow calls a reusable workflow.<\/td>Useful for creating reusable workflows that can be invoked by multiple workflows.<\/td><\/tr>
secret_scanning_alert<\/code><\/strong><\/td>Triggered when GitHub identifies sensitive data in the repository.<\/td>Automatically notify security teams or handle leaked secrets.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

Explanation of Key Events<\/strong><\/h3>\n\n\n\n
    \n
  1. push<\/code><\/strong>: This is one of the most commonly used events, triggering workflows when commits are pushed to a specific branch.<\/li>\n\n\n\n
  2. pull_request<\/code><\/strong>: Triggered whenever a pull request is opened, updated, or merged. It’s useful for running CI\/CD pipelines based on pull requests.<\/li>\n\n\n\n
  3. workflow_dispatch<\/code><\/strong>: This allows manual triggering of workflows, useful for scenarios like manually starting a deployment.<\/li>\n\n\n\n
  4. schedule<\/code><\/strong>: Allows workflows to run at specific times using cron syntax. Useful for nightly builds or periodic maintenance tasks.<\/li>\n\n\n\n
  5. release<\/code><\/strong>: Used to trigger workflows when a new release is created. This is often used for deployment workflows.<\/li>\n\n\n\n
  6. check_run<\/code> \/ check_suite<\/code><\/strong>: These events are triggered when automated checks (like CI tests) complete or fail. Actions can be taken based on the results.<\/li>\n\n\n\n
  7. deployment<\/code> \/ deployment_status<\/code><\/strong>: Automate the deployment process when a new deployment is created or monitor the deployment status to handle rollback or notification.<\/li>\n\n\n\n
  8. repository_dispatch<\/code><\/strong>: Trigger workflows from external services or systems using the GitHub API.<\/li>\n<\/ol>\n\n\n\n

    Example<\/h2>\n\n\n\n