Skip to content

Commit 87134f4

Browse files
committed
Update documentation
1 parent 6c81f28 commit 87134f4

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,31 @@ composer require --dev aeliot-tm/phpunit-codecoverage-baseline
1414
Usage
1515
-----
1616

17+
### Compare Clover report with baseline
18+
1719
1. Add baseline file to the project. See [example](docs/phpunit.clover.baseline.json).
1820
2. Run your tests with [configured](https://phpunit.readthedocs.io/en/9.5/configuration.html#the-report-element)
1921
code coverage Clover report or with [command line option](https://phpunit.readthedocs.io/en/9.5/textui.html?highlight=clover#command-line-options).
2022
```shell
2123
phpunit --coverage-clover 'build/coverage/clover.xml' tests/
2224
```
23-
3. Call [script](bin/phpunit_clover_compare).
25+
3. Call [script](bin/pccb_clover_compare).
2426
```shell
25-
vendor/bin/phpunit_clover_compare
27+
vendor/bin/pccb_clover_compare
2628
```
2729
It accepts options:
2830

2931
| Full name | Short name | Description | Default value |
3032
|--------------|------------|---------------------------|--------------------------------|
3133
| `--baseline` | `-b` | Path to the baseline | `phpunit.clover.baseline.json` |
3234
| `--clover` | `-c` | Path to the Clover report | `build/coverage/clover.xml` |
35+
36+
37+
### Build baseline for Clover report
38+
39+
1. Run your tests.
40+
2. Call [script](bin/pccb_clover_build_baseline).
41+
```shell
42+
vendor/bin/pccb_clover_build_baseline
43+
```
44+
It accepts same options like previous command.

0 commit comments

Comments
 (0)