generated from kubernetes/kubernetes-template-project
-
Notifications
You must be signed in to change notification settings - Fork 23
/
descriptiveness.go
54 lines (42 loc) · 1.71 KB
/
descriptiveness.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/*
Copyright 2020 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package main
import (
"strings"
"github.com/google/go-github/v32/github"
"sigs.k8s.io/kubebuilder-release-tools/verify/pkg/action"
)
const skipDescriptivenessCheckLabel = "skip-descriptiveness-check"
type prDescriptivenessError struct{}
func (e prDescriptivenessError) Error() string {
return "Your PR description is *really* short."
}
func (e prDescriptivenessError) Details() string {
return `It probably isn't descriptive enough.
You should give a description that highlights both what you're doing it and *why* you're doing it.
Someone reading the PR description without clicking any issue links should be able to roughly understand what's going on.`
}
// checkPRDescriptiveness
func checkPRDescriptiveness(requiredCharacters int) action.ValidateFunc {
return func(pr *github.PullRequest) (string, string, error) {
for _, label := range pr.Labels {
if label.Name != nil && *label.Name == skipDescriptivenessCheckLabel {
return "Skipping descriptiveness check!", "", nil
}
}
if len(strings.TrimSpace(pr.GetBody())) < requiredCharacters {
return "", "", &prDescriptivenessError{}
}
return "Your PR looks descriptive enough!", "", nil
}
}