Skip to content

Commit b243ca4

Browse files
committed
README: adding install and usage
Signed-off-by: Vincent Batts <[email protected]>
1 parent d614ccf commit b243ca4

File tree

1 file changed

+51
-0
lines changed

1 file changed

+51
-0
lines changed

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,55 @@
22

33
A way to do per git commit validation
44

5+
## install
56

7+
```bash
8+
vbatts@valse ~ (master) $ go get -u github.com/vbatts/git-validation
9+
```
10+
11+
## usage
12+
13+
```bash
14+
vbatts@valse ~/src/vb/git-validation (master) $ git-validation
15+
* d614ccf "*: run tests in a runner" ... PASS
16+
* b9413c6 "shortsubject: add a subject length check" ... PASS
17+
* 5e74abd "*: comments and golint" ... PASS
18+
* 07a982f "git: add verbose output of the commands run" ... PASS
19+
* 03bda4b "main: add filtering of rules to run" ... PASS
20+
* c10ba9c "Initial commit" ... PASS
21+
vbatts@valse ~/src/vb/git-validation (master) $ git-validation -v
22+
* d614ccf "*: run tests in a runner" ... PASS
23+
- PASS - has a valid DCO
24+
- PASS - commit subject is 72 characters or less! *yay*
25+
* b9413c6 "shortsubject: add a subject length check" ... PASS
26+
- PASS - has a valid DCO
27+
- PASS - commit subject is 72 characters or less! *yay*
28+
* 5e74abd "*: comments and golint" ... PASS
29+
- PASS - has a valid DCO
30+
- PASS - commit subject is 72 characters or less! *yay*
31+
* 07a982f "git: add verbose output of the commands run" ... PASS
32+
- PASS - has a valid DCO
33+
- PASS - commit subject is 72 characters or less! *yay*
34+
* 03bda4b "main: add filtering of rules to run" ... PASS
35+
- PASS - has a valid DCO
36+
- PASS - commit subject is 72 characters or less! *yay*
37+
* c10ba9c "Initial commit" ... PASS
38+
- PASS - has a valid DCO
39+
- PASS - commit subject is 72 characters or less! *yay*
40+
```
41+
42+
Here's a failure:
43+
```bash
44+
vbatts@valse ~/src/vb/git-validation (master) $ git-validation
45+
* 49f51a8 "README: adding install and usage" ... FAIL
46+
- FAIL - does not have a valid DCO
47+
* d614ccf "*: run tests in a runner" ... PASS
48+
* b9413c6 "shortsubject: add a subject length check" ... PASS
49+
* 5e74abd "*: comments and golint" ... PASS
50+
* 07a982f "git: add verbose output of the commands run" ... PASS
51+
* 03bda4b "main: add filtering of rules to run" ... PASS
52+
* c10ba9c "Initial commit" ... PASS
53+
1 issues to fix
54+
vbatts@valse ~/src/vb/git-validation (master) $ echo $?
55+
1
56+
```

0 commit comments

Comments
 (0)