@@ -10,14 +10,43 @@ vbatts@valse ~ (master) $ go get -u github.com/vbatts/git-validation
1010
1111## usage
1212
13+ The flags
1314``` bash
14- vbatts@valse ~ /src/vb/git-validation (master) $ git-validation
15+ vbatts@valse ~ /src/vb/git-validation (master * ) $ git-validation -h
16+ Usage of git-validation:
17+ -D debug output
18+ -d string
19+ git directory to validate from (default " ." )
20+ -list-rules
21+ list the rules registered
22+ -range string
23+ use this commit range instead
24+ -run string
25+ comma delimited list of rules to run. Defaults to all.
26+ -v verbose
27+ ```
28+
29+ The default rule set are all run by default:
30+ ``` bash
31+ vbatts@valse ~ /src/vb/git-validation (master) $ git-validation -list-rules
32+ " DCO" -- makes sure the commits are signed
33+ " short-subject" -- commit subjects are strictly less than 90 (github ellipsis length)
34+ ```
35+
36+ Comma delimited rules to run:
37+ ``` bash
38+ vbatts@valse ~ /src/vb/git-validation (master) $ git-validation -run DCO,short-subject
39+ * b243ca4 " README: adding install and usage" ... PASS
1540 * d614ccf " *: run tests in a runner" ... PASS
1641 * b9413c6 " shortsubject: add a subject length check" ... PASS
1742 * 5e74abd " *: comments and golint" ... PASS
1843 * 07a982f " git: add verbose output of the commands run" ... PASS
1944 * 03bda4b " main: add filtering of rules to run" ... PASS
2045 * c10ba9c " Initial commit" ... PASS
46+ ```
47+
48+ Verbosity shows each rule's output:
49+ ``` bash
2150vbatts@valse ~ /src/vb/git-validation (master) $ git-validation -v
2251 * d614ccf " *: run tests in a runner" ... PASS
2352 - PASS - has a valid DCO
0 commit comments