Skip to content

Commit 1763413

Browse files
committed
update changelog and readme
1 parent d7619c9 commit 1763413

File tree

2 files changed

+13
-1
lines changed

2 files changed

+13
-1
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@ All notable changes to `coverage-check` will be documented in this file.
44

55
---
66

7+
## 1.1.0 - 2021-07-04
8+
9+
- add `--metric/-m` option flag
10+
711
## 1.0.0 - 2021-07-03
812

913
- initial release

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,14 +38,22 @@ If you don't specify the `--require/-r` flag, only the percentage of code covera
3838
./vendor/bin/coverage-check clover.xml
3939
./vendor/bin/coverage-check clover.xml --require=50
4040
./vendor/bin/coverage-check clover.xml -r 80.5
41+
./vendor/bin/coverage-check clover.xml -m statement -r 75
4142
```
4243

4344
## Available Options
4445

4546
| Option | Description |
4647
| --- | --- |
47-
| `--require` or `-r` | Enforce a minimum code coverage value |
4848
| `--coverage-only` or `-C` | Only display the code coverage value |
49+
| `--metric` or `-m` `<name>` | Use the specified metric field for calculating coverage. Valid values are `element` _(default)_, `method`, or `statement` |
50+
| `--require` or `-r` `<value>` | Enforce a minimum code coverage value, where `<value>` is an integer or decimal value |
51+
52+
## Metric fields
53+
54+
The field that is used to calculate code coverage can be specified using the `--metric=<name>` or `-m <name>` option.
55+
56+
Valid field names are `element` _(the default)_, `statement`, and `method`.
4957

5058
## Generating clover-format coverage files
5159

0 commit comments

Comments
 (0)