Home

Welcome to the Code Coverage Summary wiki!

Code Coverage Summary is 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 any test framework that outputs coverage in Cobertura XML format. See the FAQ for a list of frameworks that have been tested. If it doesn't work with your tooling please open an issue to discuss the problem.

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.

Contents

• Using Code Coverage Summary
• .Net Workflow Example
• What do the coverage values mean?
• MATLAB Compatibility
• Simplecov Compatibility
• Verify the Docker Image
• Frequently Asked Questions