You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* 'master' of https://github.com/dropseed/commitstat:
Add go cover example and move links to paragraphs
Update README.md
Update README.md
Update README.md
Add example uses section to README
More consistent language for new stat
Copy file name to clipboardExpand all lines: README.md
+44-3Lines changed: 44 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -1,8 +1,9 @@
1
1
# commitstat
2
2
3
-
A CI tool for reporting and comparing stats on commits. It can parse a stat from a file or stdin, check whether the number has increased or decreased, and then report a pass/fail status.
4
-
5
-
Can be used to check test coverage, typing coverage, file sizes, and more.
3
+
A CI tool for reporting and comparing stats on commits and pull requests.
4
+
It can parse a stat from a file or stdin,
5
+
check whether the number has increased or decreased from the previous commit or main branch,
$ stat -f %z app.zip | commitstat - --name app-size
13
14
```
14
15
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
+
19
+
This is a lightweight alternative to hosted services like [Codecov](https://about.codecov.io/) and [Coveralls](https://coveralls.io/).
20
+
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.
21
+
There aren't any visualization tools built-in but you can always store artifacts in your CI provider or look at coverage reports locally.
0 commit comments