Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
umbrella

GitHub Action

Python Coverage

v3.1

Python Coverage

umbrella

Python Coverage

Publish coverage report to a PR & enforce coverage on new & modified files

Installation

Copy and paste the following snippet into your .yml file.

 
              
- name: Python Coverage

              
  uses: orgoro/[email protected]
Learn more about this action in orgoro/coverage

Choose a version

Python Coverage: The Esential Coverage Reporter GitHub Action for python

☂️ parse and publish coverage xml to a PR, enforce coverage rate on new & modified files

Usage

Create a new workflow .yml file in the .github/workflows/ directory.

You can create a coverage report using python:

  • pytest $ pytest --cov-report xml:path/to/coverage.xml
  • coverage $ coverage xml path/to/coverage.xml

Minimal Configuration

name: 'coverage'
on:
    pull_request:
        branches:
            - master
            - main
jobs:
    coverage:
        runs-on: ubuntu-latest
        steps:
          - name: Get Cover 
            uses: orgoro/coverage@v3
            with:
                coverageFile: path/to/coverage.xml
                token: ${{ secrets.GITHUB_TOKEN }}

PR Message & Job Summary 🆕

message

Inputs

Input Optional Description Example
coverageFile path to .xml coverage report ./path/to/coverage.xml
token your github token 🤫
thresholdAll ✅ the minimal average line coverage 0.8
thresholdNew ✅ the minimal average new files line coverage 0.9
thresholdModified ✅ the minimal average modified files line coverage 0.0
passIcon ✅ the indicator to use for files that passed 🟢
failIcon ✅ the indicator to use for files that passed 🔴