jaschilz/php-coverage-badger

Create a code coverage badge from a PHPUnit Clover XML file.

PHPCoverageBadge

PHPCoverageBadge is a library for creating an SVG coverage badge from a PHPUnit Clover XML file., _(*1)

Installation

Composer!, _(*2)

composer require --dev jaschilz/php-coverage-badger, _(*3)

Usage

1. Generate XML Code Coverage using PHPUnit
2. Run vendor/bin/php-coverage-badger /path/to/clover.xml /path/to/badge/destination.svg
   • e.g. vendor/bin/php-coverage-badger build/clover.xml report/coverage.svg

Acknowledgements

This library is forked from Michael Moussa's php-coverage-checker, derived from Marco Pivetta's post on CI test coverage checks, _(*4)

Inspiration for generating an SVG badge from coverage results is taken from the coverage-badge Python library, derived from the Shields.io project., _(*5)