Do a Github workflow trigger check_run, check_suite, and status events?

[kuisathaverat]

Question

In the context of a PR, when a workflow is complete, Are check_run, check_suite, and status events triggered?

Test case

I am trying to trigger a workflow after all the workflows triggered by a pull request finish. To do that, I check the documentation about events, and there are three that look promising check_run, check_suit, and status.

I created four workflows:

• One to manage the push on PRs

---
# Workflow to test push event
name: On push dummy
on:
  push: {}
permissions:
    contents: read
jobs:
  on-push-dummy:
    runs-on: ubuntu-latest
    steps:
      - name: Dummy step
        run: echo "This is a dummy step"

• One to catch on status

---
# Workflow to test status event
name: On status dummy
on:
  status:
permissions:
    contents: read
jobs:
  on-push-dummy:
    runs-on: ubuntu-latest
    steps:
      - name: Dummy step
        run: echo "This is a dummy step"

• One to catch on check_run

---
# Workflow to test check_run event
name: On check_run dummy
on:
  check_run:
    types: [completed]
permissions:
    contents: read
jobs:
  on-push-dummy:
    runs-on: ubuntu-latest
    steps:
      - name: Dummy step
        run: echo "This is a dummy step"

• One to catch on check_suit

---
# Workflow to test check_suite event
name: On check_suite dummy
on:
  check_suite:
    types: [completed]
permissions:
    contents: read
jobs:
  on-push-dummy:
    runs-on: ubuntu-latest
    steps:
      - name: Dummy step
        run: echo "This is a dummy step"

Then, I create a PR with a simple change in the repo. For my understanding of the documentation when the workflow On push dummy is completed it set a check on the PR as complete and it should trigger the workflow On check_run dummy and I am not sure if it should trigger On check_suite dummy because I dunno if there is a default check suit, also the PR status change to success because all workflows pass so it should trigger the workflow On status dummy.

The fact is that only the On push dummy and the others are not triggered when this one is completed, Am I doing anything wrong? How these three events are triggered? Are they triggered by the completion of a workflow?

Repository resources

I have a repo with the four workflows and the PR that I tested

• Workflows code
• On push dummy runs
• On check_run dummy runs
• On check_suit dummy runs
• On status dummy runs
• Pull request

[github-actions[bot]]

🕒 Discussion Activity Reminder 🕒

This Discussion has been labeled as dormant by an automated system for having no activity in the last 60 days. Please consider one the following actions:

1️⃣ Close as Out of Date: If the topic is no longer relevant, close the Discussion as out of date at the bottom of the page.

2️⃣ Provide More Information: Share additional details or context — or let the community know if you've found a solution on your own.

3️⃣ Mark a Reply as Answer: If your question has been answered by a reply, mark the most helpful reply as the solution.

Note: This dormant notification will only apply to Discussions with the Question label. To learn more, see our recent announcement.

Thank you for helping bring this Discussion to a resolution! 💬

[kuisathaverat]

I just asked the same question to the Support Copilot, and here is the answer:

The check_run and check_suite events are specific to GitHub Apps and are triggered under certain conditions. Based on your example and the links provided, here are some key points to consider when troubleshooting why these events might not be triggered:

1. GitHub App Permissions
   The check_run and check_suite events are only available to GitHub Apps with the appropriate permissions. Specifically, the app must have the checks:write permission to create and manage check runs.
   If you're not using a GitHub App but instead relying on OAuth apps or personal access tokens, you won't be able to trigger these events. Ensure that your app is properly configured as a GitHub App with the necessary permissions.
2. Triggering Conditions
   The check_suite event is triggered when:
   A new commit is pushed to a repository.
   A pull request is opened or synchronized.
   A user requests a re-run of a check suite.
   The check_run event is triggered when:
   A check run is created, rerequested, or completed.
   Ensure that your repository has activity that matches these conditions. For example, pushing a new commit or opening a pull request should trigger the check_suite event.
3. Webhook Configuration
   Verify that your GitHub App is subscribed to the check_run and check_suite webhook events. Without this subscription, your app won't receive the events even if they are triggered.
   You can check this in your GitHub App settings under the "Webhook" section.
4. Repository Access
   Ensure that your GitHub App has been installed on the repository where you're testing. The app must have access to the repository to receive events and perform actions.
5. Code Example Review
   In the code example you provided, ensure that the POST /repos/{owner}/{repo}/check-runs API endpoint is being called correctly. The head_sha parameter must match the commit SHA for which you want to create a check run.
   If you're using the actions_poc repository, confirm that the commit SHA (42003e72eff223a4f4b6c5e9590ec5a3c2f2fc29) is valid and that the app has access to it.
6. Testing the Setup
   To test whether your app is receiving the events, you can use a tool like smee.io to inspect the webhook payloads sent to your app. This can help you confirm whether the events are being triggered and received by your app.
7. GitHub Actions and check_run Events
   If you're using GitHub Actions, note that workflows triggered by pull_request or push events won't automatically trigger check_run or check_suite events. These events are separate and specific to GitHub Apps.
   If you've verified all the above and the events are still not triggering, it could be helpful to share more details about your GitHub App configuration or the specific steps you're taking to trigger the events. Let me know if you'd like further clarification or assistance!

Point seven is clear: if you use workflows, the event is not triggered, but point two confuses me. Is the Support Copilot answer correct?