Skip to content

:octocat: Github action to generate coverage badge without uploading results to a 3rd party.

License

Notifications You must be signed in to change notification settings

tj-actions/coverage-badge-py

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Ubuntu Mac OS Windows Public workflows that use this action.

Codacy Badge CI Update release version.

All Contributors

coverage-badge-py

Generate coverage.py badge like this coverage badge without uploading results to a 3rd party site.

Usage:

... steps: - uses: actions/checkout@v4 - name: Coverage Badge uses: tj-actions/coverage-badge-py@v2

Warning

  • 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 ⭐

Buy me a coffee

Inputs

- uses: tj-actions/coverage-badge-py@1788babcb24544eb5bbb6e0d374df5d1e54e670f # v2 id: coverage-badge-py with: # Output path to write the  # coverage badge.  # Type: string # Default: "coverage.svg" output: '' # Overwrite an existing coverage badge. # Type: boolean # Default: "true" overwrite: '' # Current working directory # Type: string # Default: "." working-directory: '' 

Example

... steps: - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v4 - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5 with: python-version: 3.13 - name: Install dependencies ... - name: Run coverage run: |  coverage run ...  coverage report -m   - name: Coverage Badge uses: tj-actions/coverage-badge-py@1788babcb24544eb5bbb6e0d374df5d1e54e670f # v2 - name: Verify Changed files uses: tj-actions/verify-changed-files@a1c6acee9df209257a246f2cc6ae8cb6581c1edf # v20 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 }}

Credits

This package was created with Cookiecutter.

Report Bugs

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.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Raphael Boidol
Raphael Boidol

📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Sponsor this project

  •  

Packages

No packages published

Contributors 11

Languages