forked from kubernetes-retired/contrib
/
release-note-label.go
163 lines (132 loc) · 4.91 KB
/
release-note-label.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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
/*
Copyright 2016 The Kubernetes Authors All rights reserved.
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 mungers
import (
"fmt"
"k8s.io/contrib/mungegithub/features"
"k8s.io/contrib/mungegithub/github"
"github.com/golang/glog"
githubapi "github.com/google/go-github/github"
"github.com/spf13/cobra"
)
const (
releaseNoteLabeler = "release-note-label"
releaseNoteLabelNeeded = "release-note-label-needed"
releaseNote = "release-note"
releaseNoteNone = "release-note-none"
releaseNoteActionRequired = "release-note-action-required"
releaseNoteFormat = `Removing LGTM because the release note process has not been followed.
One of the following labels is required %q, %q, or %q
Please see: https://github.com/kubernetes/kubernetes/blob/master/docs/devel/pull-requests.md#release-notes`
parentReleaseNoteFormat = `The 'parent' PR of cherry-picks must have either the %q or %q label or this PR must follow the release note process.`
)
var (
releaseNoteBody = fmt.Sprintf(releaseNoteFormat, releaseNote, releaseNoteNone, releaseNoteActionRequired)
parentReleaseNoteBody = fmt.Sprintf(parentReleaseNoteFormat, releaseNote, releaseNoteActionRequired)
)
// ReleaseNoteLabel will remove the LGTM label from an PR which has not
// set one of the appropriete 'release-note-*' labels.
type ReleaseNoteLabel struct {
config *github.Config
}
func init() {
r := &ReleaseNoteLabel{}
RegisterMungerOrDie(r)
RegisterStaleComments(r)
}
// Name is the name usable in --pr-mungers
func (r *ReleaseNoteLabel) Name() string { return releaseNoteLabeler }
// RequiredFeatures is a slice of 'features' that must be provided
func (r *ReleaseNoteLabel) RequiredFeatures() []string { return []string{} }
// Initialize will initialize the munger
func (r *ReleaseNoteLabel) Initialize(config *github.Config, features *features.Features) error {
r.config = config
return nil
}
// EachLoop is called at the start of every munge loop
func (r *ReleaseNoteLabel) EachLoop() error { return nil }
// AddFlags will add any request flags to the cobra `cmd`
func (r *ReleaseNoteLabel) AddFlags(cmd *cobra.Command, config *github.Config) {}
func (r *ReleaseNoteLabel) prMustFollowRelNoteProcess(obj *github.MungeObject) bool {
if obj.IsForBranch("master") {
return true
}
parents := getCherrypickParentPRs(obj, r.config)
// if it has no parents it needs to follow the release note process
if len(parents) == 0 {
return true
}
for _, parent := range parents {
// If the parent didn't set a release note, the CP must
if !parent.HasLabel(releaseNote) && !parent.HasLabel(releaseNoteActionRequired) {
if !obj.HasLabel(releaseNoteLabelNeeded) {
obj.WriteComment(parentReleaseNoteBody)
}
return true
}
}
// All of the parents set the releaseNote or releaseNoteActionRequired label, so
// this cherrypick PR needs to do nothing.
return false
}
func (r *ReleaseNoteLabel) ensureNoRelNoteNeededLabel(obj *github.MungeObject) {
if obj.HasLabel(releaseNoteLabelNeeded) {
obj.RemoveLabel(releaseNoteLabelNeeded)
}
}
// Munge is the workhorse the will actually make updates to the PR
func (r *ReleaseNoteLabel) Munge(obj *github.MungeObject) {
if !obj.IsPR() {
return
}
if completedReleaseNoteProcess(obj) {
r.ensureNoRelNoteNeededLabel(obj)
return
}
if !r.prMustFollowRelNoteProcess(obj) {
r.ensureNoRelNoteNeededLabel(obj)
return
}
if !obj.HasLabel(releaseNoteLabelNeeded) {
obj.AddLabel(releaseNoteLabelNeeded)
}
if !obj.HasLabel(lgtmLabel) {
return
}
obj.WriteComment(releaseNoteBody)
obj.RemoveLabel(lgtmLabel)
}
func completedReleaseNoteProcess(obj *github.MungeObject) bool {
return obj.HasLabel(releaseNote) || obj.HasLabel(releaseNoteActionRequired) || obj.HasLabel(releaseNoteNone)
}
func (r *ReleaseNoteLabel) isStaleComment(obj *github.MungeObject, comment githubapi.IssueComment) bool {
if !mergeBotComment(comment) {
return false
}
if *comment.Body != releaseNoteBody && *comment.Body != parentReleaseNoteFormat {
return false
}
if !r.prMustFollowRelNoteProcess(obj) {
glog.V(6).Infof("Found stale ReleaseNoteLabel comment")
return true
}
stale := completedReleaseNoteProcess(obj)
if stale {
glog.V(6).Infof("Found stale ReleaseNoteLabel comment")
}
return stale
}
// StaleComments returns a slice of stale comments
func (r *ReleaseNoteLabel) StaleComments(obj *github.MungeObject, comments []githubapi.IssueComment) []githubapi.IssueComment {
return forEachCommentTest(obj, comments, r.isStaleComment)
}