A GitHub Action that reads Cobertura format code coverage files from your test suite and outputs a text or markdown summary. This summary can be posted as a Pull Request comment or included in Release Notes by other actions to give you an immediate insight into the health of your code without using a third-party site.
Code Coverage Summary is designed for use with Coverlet and gcovr but it should work with any test framework that outputs coverage in Cobertura format. If it doesn't work with your tooling please open an issue to discuss the problem.
If you're using Simplecov please see the wiki for required settings to enable compatibility with Code Coverage Summary.
As a Docker based action Code Coverage Summary requires a Linux runner, see Types of Action. If you need to build with a Windows or MacOS runner a workaround would be to upload the coverage file as an artifact and use a separate job with a Linux runner to generate the summary.
Required
A comma separated list of code coverage files to analyse. If there are any spaces in a path or filename this value must be in quotes.
Note: Coverlet creates the coverage file in a random named directory (guid) so you need to copy it to a predictable path before running this Action, see the .Net Workflow Example below.
Include a badge reporting the Line Rate coverage in the output using shields.io - true or false (default).
| Line Rate | Badge |
|---|---|
| less than lower threshold (50%) |  |
| between thresholds (50% - 74%) |  |
| equal or greater than upper threshold (75%) |  |
See thresholds to change these values.
Fail the workflow if the overall Line Rate is below lower threshold - true or false (default). The default lower threshold is 50%, see thresholds.
Output Format - markdown or text (default).
Hide Branch Rate values in the output - true or false (default).
Hide Complexity values in the output - true or false (default).
Include health indicators in the output - true (default) or false.
| Line Rate | Indicator |
|---|---|
| less than lower threshold (50%) | ❌ |
| between thresholds (50% - 74%) | ➖ |
| equal or greater than upper threshold (75%) | ✔ |
See thresholds to change these values.
Output Type - console (default), file or both.
console will output the coverage summary to the GitHub Action log.
file will output the coverage summary to code-coverage-results.txt for text or code-coverage-results.md for markdown format in the workflow's working directory.
both will output the coverage summary to the Action log and a file as above.
Lower and upper threshold percentages for badge and health indicators, lower threshold can also be used to fail the action. Separate the values with a space and enclose them in quotes; default '50 75'.
https://img.shields.io/badge/Code%20Coverage-83%25-success?style=flat
Company.Example: Line Rate = 83%, Branch Rate = 69%, Complexity = 671, ✔
Company.Example.Library: Line Rate = 27%, Branch Rate = 100%, Complexity = 11, ❌
Summary: Line Rate = 83% (1212 / 1460), Branch Rate = 69% (262 / 378), Complexity = 682, ✔
Minimum allowed line rate is 50%
Package Line Rate Branch Rate Complexity Health Company.Example 83% 69% 671 ✔ Company.Example.Library 27% 100% 11 ❌ Summary 83% (1212 / 1460) 69% (262 / 378) 682 ✔ Minimum allowed line rate is
50%
name: Code Coverage Summary Report
uses: irongut/[email protected]
with:
filename: coverage.cobertura.xmlname: .Net 6 CI Build
on:
push:
branches: [ master ]
pull_request:
branches: [ master ]
jobs:
build:
runs-on: ubuntu-latest
name: CI Build
steps:
- name: Checkout
uses: actions/checkout@v2
- name: Setup .NET
uses: actions/setup-dotnet@v1
with:
dotnet-version: 6.0.x
- name: Restore Dependencies
run: dotnet restore src/Example.sln
- name: Build
run: dotnet build src/Example.sln --configuration Release --no-restore
- name: Test
run: dotnet test src/Example.sln --configuration Release --no-build --verbosity normal --collect:"XPlat Code Coverage" --results-directory ./coverage
- name: Copy Coverage To Predictable Location
run: cp coverage/**/coverage.cobertura.xml coverage.cobertura.xml
- name: Code Coverage Summary Report
uses: irongut/[email protected]
with:
filename: coverage.cobertura.xml
badge: true
fail_below_min: true
format: markdown
hide_branch_rate: false
hide_complexity: true
indicators: true
output: both
thresholds: '60 80'
- name: Add Coverage PR Comment
uses: marocchino/sticky-pull-request-comment@v2
if: github.event_name == 'pull_request'
with:
recreate: true
path: code-coverage-results.mdVersion numbers will be assigned according to the Semantic Versioning scheme. This means, given a version number MAJOR.MINOR.PATCH, we will increment the:
- MAJOR version when we make incompatible API changes
- MINOR version when we add functionality in a backwards compatible manner
- PATCH version when we make backwards compatible bug fixes
Please make sure the bug is not already reported by searching existing issues.
If you're unable to find an existing issue addressing the problem please open a new one. Be sure to include a title and clear description, as much relevant information as possible, a workflow sample and any logs demonstrating the problem.
Please open a new issue.
Discuss your idea first, so that your changes have a good chance of being merged in.
Submit your pull request against the master branch.
Pull requests that include documentation and relevant updates to README.md are merged faster, because you won't have to wait for somebody else to complete your contribution.
Code Coverage Summary is available under the MIT license, see the LICENSE file for more info.