Skip to content

Commit d5c7c43

Browse files
committed
add note about CI and the exit code, closes #30
1 parent 6ed99ca commit d5c7c43

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ check-total
6060
check-total --from coverage/coverage-summary.json --min 80
6161
```
6262

63+
The command exits with 0 if the total is above or equal to the minimum number. If the code coverage is below the minimum, the command exits with code 1. On most CIs any command exiting with non-zero code fails the build.
64+
6365
## update-badge
6466

6567
If your README.md includes Shields.io badge, like this

0 commit comments

Comments
 (0)