Skip to content

There is a duplicate paragraph in events-that-trigger-workflows.md #38444

Closed
@norwd

Description

@norwd

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#push

What part(s) of the article would you like to see updated?

The duplicated portions are the two "Note" blocks:

> [!NOTE]
> {% data reusables.actions.branch-paths-filter %} For example, the following workflow will only run when a push that includes a change to a JavaScript (`.js`) file is made to a branch whose name starts with `releases/`:
>
> ```yaml
> on:
> push:
> branches:
> - 'releases/**'
> paths:
> - '**.js'
> ```

> [!NOTE]
> {% data reusables.actions.branch-paths-filter %} For example, the following workflow will only run when a push that includes a change to a JavaScript (`.js`) file is made to a branch whose name starts with `releases/`:
>
> ```yaml
> on:
> push:
> branches:
> - 'releases/**'
> paths:
> - '**.js'
> ```

What I believe is the original intent (based on the surrounding context) is that the second block was originally going to say that "If you use both the tags filter and the paths filter, the workflow will only run when both filters are satisfied.", as opposed to mentioning the branches twice. Assuming that this is in fact correct, I've created a PR that updates the documentation to say so in this PR.

Additional information

Are you able to reliably reproduce the problem?

Yes, just go to https://docs.github.com/en/actions/writing-workflows/choosing-when-your-workflow-runs/events-that-trigger-workflows#push

How often does it occur?

Everytime.

How many users are affected?

All GHA users that are reading the documentation for the push event.

Add any other context or screenshots about the feature here.

The documentation for the push event in events-that-trigger-workflows.md has a duplicate paragraph. I've tried to fit both duplicates in one screen shot, hopefully it's clear.

Image

Edit: add the PR link

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamgithub_actionsPull requests that update GitHub Actions code

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions