mirrors/git-validation
1
0
Fork 0
mirror of https://github.com/vbatts/git-validation.git synced 2024-11-17 22:08:39 +00:00
Code Releases Activity

README: more usage

Browse source 
Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
This commit is contained in:
Vincent Batts 2015-10-06 10:51:22 -04:00
parent b243ca4770
commit 09c2bd43dc
1 changed files with 30 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
README.md
View file

@ -10,14 +10,43 @@ vbatts@valse ~ (master) $ go get -u github.com/vbatts/git-validation
## usage ## usage
The flags
```bash ```bash
vbatts@valse ~/src/vb/git-validation (master) $ git-validation vbatts@valse ~/src/vb/git-validation (master *) $ git-validation -h
Usage of git-validation:
-D debug output
-d string
git directory to validate from (default ".")
-list-rules
list the rules registered
-range string
use this commit range instead
-run string
comma delimited list of rules to run. Defaults to all.
-v verbose
```
The default rule set are all run by default:
```bash
vbatts@valse ~/src/vb/git-validation (master) $ git-validation -list-rules
"DCO" -- makes sure the commits are signed
"short-subject" -- commit subjects are strictly less than 90 (github ellipsis length)
```
Comma delimited rules to run:
```bash
vbatts@valse ~/src/vb/git-validation (master) $ git-validation -run DCO,short-subject
* b243ca4 "README: adding install and usage" ... PASS
* d614ccf "*: run tests in a runner" ... PASS * d614ccf "*: run tests in a runner" ... PASS
* b9413c6 "shortsubject: add a subject length check" ... PASS * b9413c6 "shortsubject: add a subject length check" ... PASS
* 5e74abd "*: comments and golint" ... PASS * 5e74abd "*: comments and golint" ... PASS
* 07a982f "git: add verbose output of the commands run" ... PASS * 07a982f "git: add verbose output of the commands run" ... PASS
* 03bda4b "main: add filtering of rules to run" ... PASS * 03bda4b "main: add filtering of rules to run" ... PASS
* c10ba9c "Initial commit" ... PASS * c10ba9c "Initial commit" ... PASS
```
Verbosity shows each rule's output:
```bash
vbatts@valse ~/src/vb/git-validation (master) $ git-validation -v vbatts@valse ~/src/vb/git-validation (master) $ git-validation -v
* d614ccf "*: run tests in a runner" ... PASS * d614ccf "*: run tests in a runner" ... PASS
- PASS - has a valid DCO - PASS - has a valid DCO