Skip to content

Commit 54648d7

Browse files
authored
Clarify edge-case behavior for check runs and suites (#56958)
1 parent 98134e4 commit 54648d7

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

content/actions/reference/workflows-and-actions/events-that-trigger-workflows.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,9 @@ on:
5656

5757
{% data reusables.actions.branch-requirement %}
5858

59+
> [!NOTE]
60+
> To prevent recursive workflows, this event does not trigger workflows if the check run's check suite was created by {% data variables.product.prodname_actions %} or if the check suite's head SHA is associated with {% data variables.product.prodname_actions %}.
61+
5962
Runs your workflow when activity related to a check run occurs. A check run is an individual test that is part of a check suite. For information, see [AUTOTITLE](/rest/guides/using-the-rest-api-to-interact-with-checks). For information about the check run APIs, see [AUTOTITLE](/graphql/reference/objects#checkrun) in the GraphQL API documentation or [AUTOTITLE](/rest/checks/runs).
6063

6164
For example, you can run a workflow when a check run has been `rerequested` or `completed`.
@@ -78,7 +81,7 @@ on:
7881
{% data reusables.actions.branch-requirement %}
7982

8083
> [!NOTE]
81-
> To prevent recursive workflows, this event does not trigger workflows if the check suite was created by {% data variables.product.prodname_actions %}.
84+
> To prevent recursive workflows, this event does not trigger workflows if the check suite was created by {% data variables.product.prodname_actions %} or if the check suite's head SHA is associated with {% data variables.product.prodname_actions %}.
8285

8386
Runs your workflow when check suite activity occurs. A check suite is a collection of the check runs created for a specific commit. Check suites summarize the status and conclusion of the check runs that are in the suite. For information, see [AUTOTITLE](/rest/guides/using-the-rest-api-to-interact-with-checks). For information about the check suite APIs, see [AUTOTITLE](/graphql/reference/objects#checksuite) in the GraphQL API documentation or [AUTOTITLE](/rest/checks/suites).
8487

0 commit comments

Comments
 (0)