Skip to content

Commit cfe4751

Browse files
committed
Document options in README
1 parent 5f93047 commit cfe4751

File tree

1 file changed

+1
-5
lines changed

1 file changed

+1
-5
lines changed

README.md

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,6 @@ and then report a pass/fail status on GitHub.
99
$ commitstat coverage-report.txt --regex "\| Total\s*\|\s*([\d\.]+%)" --goal increase --name coverage
1010
```
1111

12-
```console
13-
$ stat -f %z app.zip | commitstat - --name app-size
14-
```
15-
1612
Can be used to check test coverage, typing coverage, file sizes, and more.
1713
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.
1814

@@ -83,5 +79,5 @@ Parse total test coverage from the [built-in go coverage tool](https://blog.gola
8379

8480
```console
8581
$ go test ./... -coverprofile=coverage.out
86-
$ go tool cover -func coverage.out | commitstat - --regex "total:\s+\(statements\)\s+([\d\.]+%)" --name coverage
82+
$ go tool cover -func coverage.out | commitstat - --regex "total:\s+\(statements\)\s+([\d\.]+%)" --goal increase --name coverage
8783
```

0 commit comments

Comments
 (0)