Skip to content

Commit

Permalink
Add a small section on "PR comments on push" mode
Browse files Browse the repository at this point in the history
  • Loading branch information
ewjoachim committed Sep 17, 2023
1 parent 5873e03 commit 6141a7a
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -203,7 +203,6 @@ jobs:
GITHUB_TOKEN: ${{ github.token }}
```
### Merging multiple coverage reports
In case you have a job matrix and you want the report to be on the global
Expand Down Expand Up @@ -351,6 +350,16 @@ jobs:
VERBOSE: false
```
### Commenting on the PR on the `push` event

This action's PR comments with coverage reports is designed to work when
running on the `pull_request` events. That being said, if your CI is running on
feature branches on the `push` events and not on the `pull_request` events, we
partly support a mode where the action can comment on the PR when running on
the `push` events instead. This is most likely only useful for setups not
accepting external PRs and you will not have the best user experience.
If that's something you need to do, please have a look at [this issue](https://github.com/py-cov-action/python-coverage-comment-action/issues/234).

## Overriding the template

By default, comments are generated from a
Expand Down

0 comments on commit 6141a7a

Please sign in to comment.