GitHub Actions: add more details for "workflow_run" event

[BrightRan]

Associated GitHub Community: https://github.community/t/workflow-run-not-working-as-expected/139342

According to the docs about the workflow_run event, we can use the workflow_run event to trigger another workflow after a workflow run is requested or completed.

According to our tests, the workflow_run event can trigger the workflow only when the workflow file is on the default branch. However, we can't see any note about this point in the docs.

We can see the below note for some events (such as issues, label, etc.) in the docs:

Note: This event will only trigger a workflow run if the workflow file is on the default branch.

But why you did not add the same Note for the workflow_run event. This Note also is applied to the workflow_run event.

[janiceilene]

👋 @BrightRan Thanks so much for opening an issue! Does this Add more details about workflow_run PR cover the information you're looking for?

[BrightRan]

Yes, that's what we want.
Thanks, @janiceilene .

[alexpapworth]

Hiya, I feel like this is still an issue. As of today (18th November) the workflow_run section doesn't explicitly state that it won't run until you've merged the workflow file into the default branch.

---

---

Would be great if we can add the same "Note:" section, similar to what we have on the check_run event.

---

---

[janiceilene]

👋 @BrightRan I'll triage this for the team to take a look 👀

[lucascosti]

Default branch note has now been added: https://docs.github.com/en/free-pro-team@latest/actions/reference/events-that-trigger-workflows#workflow_run 🎉

[alexpapworth]

Thanks Lucas 😊

[Morriz]

Where can we find the documentation that describes the github.event.workflow_run object? It has many properties but I don't find docs on that.