mirrors/git-validation
1
0
Fork 0
mirror of https://github.com/vbatts/git-validation.git synced 2024-11-26 10:05:40 +00:00
Code Releases Activity

README: doc the exclude function

Browse source 
https://github.com/vbatts/git-validation/pull/21

Signed-off-by: Vincent Batts <vbatts@hashbangbash.com>
This commit is contained in:
Vincent Batts 2017-04-27 10:29:28 -04:00
parent 9c912afea5
commit 04d7733885
Signed by: vbatts
GPG key ID: 10937E57733F1362
1 changed files with 13 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -5,14 +5,14 @@ A way to do validation on git commits.
## install
```bash
```console
vbatts@valse ~ (master) $ go get -u github.com/vbatts/git-validation
```
## usage
The flags
```bash
```console
vbatts@valse ~/src/vb/git-validation (master *) $ git-validation -h
Usage of git-validation:
-D debug output
@ -28,14 +28,14 @@ Usage of git-validation:
```
The entire default rule set is run by default:
```bash
```console
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)
```
Or, specify comma-delimited rules to run:
```bash
```console
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
@ -47,7 +47,7 @@ vbatts@valse ~/src/vb/git-validation (master) $ git-validation -run DCO,short-su
```
Verbosity shows each rule's output:
```bash
```console
vbatts@valse ~/src/vb/git-validation (master) $ git-validation -v
* d614ccf "*: run tests in a runner" ... PASS
- PASS - has a valid DCO
@ -70,7 +70,7 @@ vbatts@valse ~/src/vb/git-validation (master) $ git-validation -v
```
Here's a failure:
```bash
```console
vbatts@valse ~/src/vb/git-validation (master) $ git-validation
* 49f51a8 "README: adding install and usage" ... FAIL
- FAIL - does not have a valid DCO
@ -85,6 +85,13 @@ vbatts@valse ~/src/vb/git-validation (master) $ echo $?
1
```
Excluding paths that are out of the scope of your project:
```console
vbatts@valse ~/src/vb/git-validation (master) $ GIT_CHECK_EXCLUDE="./vendor" git-validation -q -run dangling-whitespace
...
```
using the `GIT_CHECK_EXCLUDE` environment variable
## Rules
Default rules are added by registering them to the `validate` package.