GitHub Action
coverage.py badge
v2.0.3
Latest version
Generate coverage.py badge like this 
without uploading results to a 3rd party site.
...
steps:
- uses: actions/checkout@v2
- name: Coverage Badge
uses: tj-actions/coverage-badge-py@v2NOTE:
⚠️
- It's important that you run this action from the directory where the .coverage data file is located.
If you feel generous and want to show some extra appreciation:
Support this project with a ⭐
| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION |
|---|---|---|---|---|
| output | string | false | "coverage.svg" |
Output path to write the coverage badge. |
| overwrite | string | false | "true" |
Overwrite an existing coverage badge. |
| working-directory | string | false | "." |
Current working directory |
...
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
- uses: actions/setup-python@v4
with:
python-version: 3.11
- name: Install dependencies
...
- name: Run coverage
run: |
coverage run ...
coverage report -m
- name: Coverage Badge
uses: tj-actions/coverage-badge-py@v2
- name: Verify Changed files
uses: tj-actions/verify-changed-files@v14
id: verify-changed-files
with:
files: coverage.svg
- name: Commit files
if: steps.verify-changed-files.outputs.files_changed == 'true'
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
git config --local user.name "github-actions[bot]"
git add coverage.svg
git commit -m "Updated coverage.svg"
- name: Push changes
if: steps.verify-changed-files.outputs.files_changed == 'true'
uses: ad-m/github-push-action@master
with:
github_token: ${{ secrets.github_token }}
branch: ${{ github.ref }}- Free software: MIT license
This package was created with Cookiecutter.
Report bugs at https://github.com/tj-actions/coverage-badge-py/issues.
If you are reporting a bug, please include:
- Your operating system name and version.
- Any details about your workflow that might be helpful in troubleshooting.
- Detailed steps to reproduce the bug.