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

Update README.md #334

Merged
merged 2 commits into from
Jan 1, 2024
Merged

Update README.md #334

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7aecb60
Update README.md
ewjoachim Jan 1, 2024
d142250
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Jan 1, 2024
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
20 changes: 16 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,28 @@

## Presentation

Publish diff coverage report as PR comment, create a coverage badge to
display on the readme, and a browsable HTML coverage report (hosted in a dedicated
branch of the repository)
This action analyses the coverage data produced by the Python
[coverage](https://coverage.readthedocs.io) library and produces:

- A badge to display on your README
- A comment in the pull requests detailing how the PR impacts the coverage:
- Old and new coverage rates per file and total
- Coverage of new lines per file and total
- (optional) Annotations on lines missing coverage displayed in the PR directly
- A [Job Summary](https://github.blog/2022-05-09-supercharging-github-actions-with-job-summaries/)
- A browsable folder containing:
- The coverage summary
- The full HTML coverage in a browsable format (not available for private repos)

All of this is free of charge and runs on the GitHub infrastructure: your code isn't sent
anywhere out of GitHub.

[See this action in action](https://github.com/py-cov-action/python-coverage-comment-action-v3-example)

## What does it do?

This action operates on an already generated `.coverage` file from
[coverage](https://coverage.readthedocs.io/en/6.2/).
[coverage](https://coverage.readthedocs.io).

It has two main modes of operation:

Expand Down
Loading