From 413b0149705fe7b1f07203af6d714a813e4cca54 Mon Sep 17 00:00:00 2001 From: Joachim Jablon Date: Sun, 17 Sep 2023 20:45:12 +0200 Subject: [PATCH] Add a small section on "PR comments on push" mode --- README.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 278dc943..4525d8c2 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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 also when running +on the `push` events. 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