mirror of
https://github.com/vbatts/git-validation.git
synced 2024-12-28 08:16:31 +00:00
*: fix typos and stuff
because that's what I do Signed-off-by: Jonathan Boulle <jon.boulle@coreos.com>
This commit is contained in:
parent
769b4028a4
commit
41062f1be2
3 changed files with 7 additions and 7 deletions
|
@ -1,6 +1,6 @@
|
|||
# git-validation
|
||||
|
||||
A way to do per git commit validation
|
||||
A way to do validation on git commits.
|
||||
|
||||
## install
|
||||
|
||||
|
@ -26,14 +26,14 @@ Usage of git-validation:
|
|||
-v verbose
|
||||
```
|
||||
|
||||
The default rule set are all run by default:
|
||||
The entire default rule set is 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:
|
||||
Or, specify 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
|
||||
|
@ -91,5 +91,5 @@ Usually by putting them in their own package.
|
|||
See [`./rules/`](./rules/).
|
||||
Feel free to contribute more.
|
||||
|
||||
Otherwise, but using `validate` package API directly, rules can be handed directly to the `validate.Runner`.
|
||||
Otherwise, by using `validate` package API directly, rules can be handed directly to the `validate.Runner`.
|
||||
|
||||
|
|
|
@ -23,7 +23,7 @@ var (
|
|||
}
|
||||
)
|
||||
|
||||
// ValidateDCO is the ValidateRule for a git commit
|
||||
// ValidateDCO checks that the commit has been signed off, per the DCO process
|
||||
func ValidateDCO(c git.CommitEntry) (vr validate.Result) {
|
||||
vr.CommitEntry = c
|
||||
if len(strings.Split(c["parent"], " ")) > 1 {
|
||||
|
|
|
@ -19,7 +19,7 @@ func init() {
|
|||
}
|
||||
|
||||
// ValidateShortSubject checks that the commit's subject is strictly less than
|
||||
// 90 characters (preferrably not more than 72 chars).
|
||||
// 90 characters (preferably not more than 72 chars).
|
||||
func ValidateShortSubject(c git.CommitEntry) (vr validate.Result) {
|
||||
if len(c["subject"]) >= 90 {
|
||||
vr.Pass = false
|
||||
|
@ -28,7 +28,7 @@ func ValidateShortSubject(c git.CommitEntry) (vr validate.Result) {
|
|||
}
|
||||
vr.Pass = true
|
||||
if len(c["subject"]) > 72 {
|
||||
vr.Msg = "commit subject is not more than 90 characters, but is still more than 72 chars"
|
||||
vr.Msg = "commit subject is under 90 characters, but is still more than 72 chars"
|
||||
} else {
|
||||
vr.Msg = "commit subject is 72 characters or less! *yay*"
|
||||
}
|
Loading…
Reference in a new issue