Skip to content

Commit 0b76511

Browse files
authored
Update README.md
1 parent 10a6b52 commit 0b76511

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@ It can parse a stat from a file or stdin,
55
check whether the number has increased or decreased from the previous commit or main branch,
66
and then report a pass/fail status on GitHub.
77

8-
Can be used to check test coverage, typing coverage, file sizes, and more.
9-
108
```console
119
$ commitstat coverage-report.txt --regex "\| Total\s*\|\s*([\d\.]+%)" --goal increase --name coverage
1210
```
@@ -15,10 +13,15 @@ $ commitstat coverage-report.txt --regex "\| Total\s*\|\s*([\d\.]+%)" --goal inc
1513
$ stat -f %z app.zip | commitstat - --name app-size
1614
```
1715

16+
Can be used to check test coverage, typing coverage, file sizes, and more.
17+
The status can be purely informative, or be set as a required status check (via GitHub branch protection) to ensure that something like test coverage doesn't get worse because of a pull request.
18+
1819
This is a lightweight alternative to hosted services like [Codecov](https://about.codecov.io/) and [Coveralls](https://coveralls.io/).
1920
All of the data that commitstat uses is stored directly in the GitHub commit status and doesn't involve any third-party services or hosting.
2021
There aren't any visualization tools built-in but you can always store artifacts in your CI provider or look at coverage reports locally.
2122

23+
![commitstat-example](https://user-images.githubusercontent.com/649496/121426939-c166f100-c939-11eb-8061-f97cf0f10407.png)
24+
2225
## Quick install
2326

2427
You can install commitstat locally to test your parsing patterns, but commit statuses will only be created when run in CI.

0 commit comments

Comments
 (0)