Frequently Asked Questions

Which testing tools does CCS work with?

Code Coverage Summary is designed for use with any test framework that outputs coverage in Cobertura XML format. It has been tested with:

• Coverlet
• gcovr
• simplecov (see compatibility guide)
• simplecov-cobertura (see compatibility guide)
• MATLAB (see compatibility guide)

Other frameworks that output test coverage in Cobertura format should work including:

• coverage.py
• Istanbul
• Jest
• Maven

If CCS doesn't work with your tooling please open an issue to discuss the problem.

Where is the coverage file?

Some tools, such as Coverlet, create the coverage file in a randomly named directory so you need to:

• use a glob pattern to match the filename, like coverage/**/coverage.cobertura.xml
• or, copy it to a predictable path before running the Action

Is this Action only for Linux?

Unfortunately as a Docker based Action, Code Coverage Summary will only work on a Linux runner. This is a GitHub Actions limitation, see Types of Action.

If you need to build your code with a Windows or MacOS runner, a possible workaround would be to upload the coverage file from the build job as an artifact and use a separate job with a Linux runner to generate the summary.