Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add a small section on "PR comments on push" mode #265

Merged
merged 1 commit into from
Sep 17, 2023
Merged

Add a small section on "PR comments on push" mode #265

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
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
Loading