https://github.com/aeliot-tm/phpunit-codecoverage-baseline

Script for the comparing of code coverage
https://github.com/aeliot-tm/phpunit-codecoverage-baseline

baseline code-coverage code-coverage-baseline phpunit phpunit-baseline

Last synced: 4 months ago
JSON representation

Script for the comparing of code coverage

• Host: GitHub
• URL: https://github.com/aeliot-tm/phpunit-codecoverage-baseline
• Owner: Aeliot-Tm
• License: mit
• Created: 2023-01-25T20:00:36.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-11T04:55:55.000Z (6 months ago)
• Last Synced: 2025-01-31T03:25:20.971Z (5 months ago)
• Topics: baseline, code-coverage, code-coverage-baseline, phpunit, phpunit-baseline
• Language: PHP
• Homepage:
• Size: 121 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
PHPUnit code coverage baseline

==============================

[![WFS](https://github.com/Aeliot-Tm/phpunit-codecoverage-baseline/actions/workflows/automated_testing.yml/badge.svg?branch=main)](https://github.com/Aeliot-Tm/phpunit-codecoverage-baseline/actions)

[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/Aeliot-Tm/phpunit-codecoverage-baseline?label=Maintainability&labelColor=black)](https://codeclimate.com/github/Aeliot-Tm/phpunit-codecoverage-baseline)

Package implements support of baseline for Clover repost of PHPUnit.

Installation

------------

Call command line script to install: 

```shell

composer require --dev aeliot-tm/phpunit-codecoverage-baseline

```

Usage

-----

**To get started:**

1. Run PHPUnit with the switched on Clover report in [xml config file](https://phpunit.readthedocs.io/en/9.5/configuration.html#the-report-element)

   or with [command-line options](https://phpunit.readthedocs.io/en/9.5/textui.html?highlight=clover#command-line-options).

   ```shell

   phpunit --coverage-clover 'build/coverage/clover.xml' tests/

   ```

2. [Build baseline](docs/clover_build_baseline.md) for clover report and commit into your project.

**Regular using:**

1. [Run comparing](docs/clover_compare_with_baseline.md) of current Clover report with the baseline. 

   It is recommended to configure it on your GitHub or GitLab CI.

2. Update your baseline time-to-time when you have progress with your code coverage.