jaschilz/php-coverage-badger

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

2.0.0 2017-07-21 20:03 UTC

This package is not auto-updated.

Last update: 2020-08-08 05:25:56 UTC


README

PHPCoverageBadge is a library for creating an SVG coverage badge from a PHPUnit Clover XML file.

Installation

Composer!

composer require --dev jaschilz/php-coverage-badger

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

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