@@ -6,14 +6,15 @@ A way to do validation on git commits.
6
6
7
7
## install
8
8
9
- ``` console
10
- vbatts@valse ~ (master) $ go install github.com/vbatts/git-validation@latest
9
+ ``` shell
10
+ go install github.com/vbatts/git-validation@latest
11
11
```
12
12
13
13
## usage
14
14
15
15
The flags
16
- ``` console
16
+
17
+ ``` shell
17
18
vbatts@valse ~ /src/vb/git-validation (master * ) $ git-validation -h
18
19
Usage of git-validation:
19
20
-D debug output
@@ -29,7 +30,8 @@ Usage of git-validation:
29
30
```
30
31
31
32
The entire default rule set is run by default:
32
- ``` console
33
+
34
+ ``` shell
33
35
vbatts@valse ~ /src/vb/git-validation (master) $ git-validation -list-rules
34
36
" dangling-whitespace" -- checking the presence of dangling whitespaces on line endings
35
37
" DCO" -- makes sure the commits are signed
@@ -38,7 +40,8 @@ vbatts@valse ~/src/vb/git-validation (master) $ git-validation -list-rules
38
40
```
39
41
40
42
Or, specify comma-delimited rules to run:
41
- ``` console
43
+
44
+ ``` shell
42
45
vbatts@valse ~ /src/vb/git-validation (master) $ git-validation -run DCO,short-subject
43
46
* b243ca4 " README: adding install and usage" ... PASS
44
47
* d614ccf " *: run tests in a runner" ... PASS
@@ -50,7 +53,8 @@ vbatts@valse ~/src/vb/git-validation (master) $ git-validation -run DCO,short-su
50
53
```
51
54
52
55
Verbosity shows each rule's output:
53
- ``` console
56
+
57
+ ``` shell
54
58
vbatts@valse ~ /src/vb/git-validation (master) $ git-validation -v
55
59
* d614ccf " *: run tests in a runner" ... PASS
56
60
- PASS - has a valid DCO
@@ -73,7 +77,8 @@ vbatts@valse ~/src/vb/git-validation (master) $ git-validation -v
73
77
```
74
78
75
79
Here's a failure:
76
- ``` console
80
+
81
+ ``` shell
77
82
vbatts@valse ~ /src/vb/git-validation (master) $ git-validation
78
83
* 49f51a8 " README: adding install and usage" ... FAIL
79
84
- FAIL - does not have a valid DCO
@@ -89,12 +94,13 @@ vbatts@valse ~/src/vb/git-validation (master) $ echo $?
89
94
```
90
95
91
96
Excluding paths that are out of the scope of your project:
92
- ``` console
97
+
98
+ ``` shell
93
99
vbatts@valse ~ /src/vb/git-validation (master) $ GIT_CHECK_EXCLUDE=" ./vendor:./git/testdata" git-validation -q -run dangling-whitespace
94
100
...
95
101
```
96
- using the ` GIT_CHECK_EXCLUDE ` environment variable. Multiple paths should be separated by colon(` : ` )
97
102
103
+ using the ` GIT_CHECK_EXCLUDE ` environment variable. Multiple paths should be separated by colon(` : ` )
98
104
99
105
## Rules
100
106
@@ -104,4 +110,3 @@ See [`./rules/`](./rules/).
104
110
Feel free to contribute more.
105
111
106
112
Otherwise, by using ` validate ` package API directly, rules can be handed directly to the ` validate.Runner ` .
107
-
0 commit comments