mirror of
https://github.com/irongut/CodeCoverageSummary.git
synced 2026-05-17 23:40:13 +02:00
updated readme
This commit is contained in:
@@ -19,7 +19,13 @@ Note: Coverlet creates the coverage file in a random named directory (guid) so y
|
|||||||
|
|
||||||
Include a badge reporting the Line Rate coverage in the output using [shields.io](https://shields.io/) - `true` or `false` (default).
|
Include a badge reporting the Line Rate coverage in the output using [shields.io](https://shields.io/) - `true` or `false` (default).
|
||||||
|
|
||||||
If the overall Line Rate is less than the lower threshold (50%) the badge will be red, if it is between thresholds it will be yellow and if it greater than or equal to the higher threshold (75%) it will be green. See [`thresholds`](#thresholds) to change these values.
|
Line Rate | Badge
|
||||||
|
--------- | ---------
|
||||||
|
less than lower threshold (50%) | 
|
||||||
|
between thresholds (50% - 74%) | 
|
||||||
|
equal or greater than upper threshold (75%) | 
|
||||||
|
|
||||||
|
See [`thresholds`](#thresholds) to change these values.
|
||||||
|
|
||||||
#### `fail_below_min`
|
#### `fail_below_min`
|
||||||
**v1.1.0-beta only**
|
**v1.1.0-beta only**
|
||||||
@@ -33,7 +39,7 @@ Output Format - `markdown` or `text` (default).
|
|||||||
#### `indicators`
|
#### `indicators`
|
||||||
**v1.1.0-beta only**
|
**v1.1.0-beta only**
|
||||||
|
|
||||||
Include health indicators in the output - `true` (default) or `false`.'
|
Include health indicators in the output - `true` (default) or `false`.
|
||||||
|
|
||||||
Line Rate | Indicator
|
Line Rate | Indicator
|
||||||
--------- | ---------
|
--------- | ---------
|
||||||
|
|||||||
Reference in New Issue
Block a user