-
Notifications
You must be signed in to change notification settings - Fork 64.1k
Description
Code of Conduct
- I have read and agree to the GitHub Docs project's Code of Conduct
What article on docs.github.com is affected?
https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows
What part(s) of the article would you like to see updated?
Most events listed on this page include a note which says "By default, all activity types trigger a workflow to run. You can limit your workflow runs to specific activity types using the types keyword." This sounds like a general statement that applies to all events and not just to the event that is being discussed at the place where the note occurs. Since there are certain events for which this is not true—namely, the pull_request and pull_request_target events, which by default are triggered only by the opened, synchronize, and reopened activity types—the wording of these notes could easily cause confusion.
I would suggest rewording the first sentence of this portion of the notes to read "By default, all activity types trigger workflows that run on this event."
The text for this note is contained in data/reusables/developer-site/limit_workflow_to_activity_types.md, a reusable that is only used on the Events that trigger workflows page.
Additional information
No response