Skip to content

Unclear notes about which activities for which events trigger workflows #18419

@gsrohde

Description

@gsrohde

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content team

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions