actions-marketplace-validations/Python Coverage Comment

Publish diff coverage report as PR comment, and create a coverage badge to display on the readme.

Trust Signals

Scorecard Score: not yet scored
Maintenance Recency: Stale
License: None

Inputs

name	description	required	default
GITHUB_TOKEN	A GitHub token to write comments and write the badge & coverage data to the repository. Set to `$ {{ github.token }}` (without the space between `$` and `{`).	yes	—
GITHUB_PR_RUN_ID	Only useful on the "workflow_run" part of the workflow. Set to `$ {{ github.event.workflow_run.id }}` (without the space between `$` and `{`).	no	—
COMMENT_TEMPLATE	[Advanced] Specify a different template for the comments that will be written on the PR. See the Action README documentation for how to use this properly.	no	—
COVERAGE_DATA_BRANCH	Name of the branch in which coverage data will be stored on the repository. Default is 'python-coverage-comment-action-data'. Please make sure that this branch is not protected.	no	python-coverage-comment-action-data
COMMENT_ARTIFACT_NAME	Name of the artifact in which the body of the comment to post on the PR is stored.	no	python-coverage-comment-action
COMMENT_FILENAME	Name of the file in which the body of the comment to post on the PR is stored.	no	python-coverage-comment-action.txt
MINIMUM_GREEN	If the coverage percentage is above or equal to this value, the badge will be green.	no	100
MINIMUM_ORANGE	If the coverage percentage is not green and above or equal to this value, the badge will be orange. Otherwise it will be red.	no	70
MERGE_COVERAGE_FILES	If true, will run `coverage combine` before reading the `.coverage` file.	—	false
ANNOTATE_MISSING_LINES	If true, will create an annotation on every line with missing coverage on a pull request.	—	false
ANNOTATION_TYPE	Only needed if ANNOTATE_MISSING_LINES is set to true. This parameter allows you to choose between notice, warning and error as annotation type. For more information look here: https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#setting-a-notice-message	—	warning
VERBOSE	If true, produces more output. Useful for debugging.	—	false

Outputs

name	description
COMMENT_FILE_WRITTEN	If "true", a comment file was written to COMMENT_FILENAME. If "false", no comment file was written (because the comment was already posted).