Skip to content

Commit 66ef4ab

Browse files
authored
fix: only print controller comment for Go projects (#4742)
1 parent 7e43b47 commit 66ef4ab

File tree

4 files changed

+17
-154
lines changed

4 files changed

+17
-154
lines changed

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ require (
3636
rsc.io/letsencrypt v0.0.3 // indirect
3737
sigs.k8s.io/controller-runtime v0.8.2
3838
sigs.k8s.io/controller-tools v0.5.0
39-
sigs.k8s.io/kubebuilder/v3 v3.0.0-alpha.0.0.20210407152553-d5e70a57ccb0
39+
sigs.k8s.io/kubebuilder/v3 v3.0.0-rc.0
4040
sigs.k8s.io/yaml v1.2.0
4141
)
4242

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1557,8 +1557,8 @@ sigs.k8s.io/controller-tools v0.4.1 h1:VkuV0MxlRPmRu5iTgBZU4UxUX2LiR99n3sdQGRxZF
15571557
sigs.k8s.io/controller-tools v0.4.1/go.mod h1:G9rHdZMVlBDocIxGkK3jHLWqcTMNvveypYJwrvYKjWU=
15581558
sigs.k8s.io/controller-tools v0.5.0 h1:3u2RCwOlp0cjCALAigpOcbAf50pE+kHSdueUosrC/AE=
15591559
sigs.k8s.io/controller-tools v0.5.0/go.mod h1:JTsstrMpxs+9BUj6eGuAaEb6SDSPTeVtUyp0jmnAM/I=
1560-
sigs.k8s.io/kubebuilder/v3 v3.0.0-alpha.0.0.20210407152553-d5e70a57ccb0 h1:7xXfjzq8NfOwBEo3ZGa/+G5uABPfHIDXdoy3ERn5kxQ=
1561-
sigs.k8s.io/kubebuilder/v3 v3.0.0-alpha.0.0.20210407152553-d5e70a57ccb0/go.mod h1:eVtLdWzmvL1ixDYLlVrvQe8wjpikJVoSOg5PghTk2Lw=
1560+
sigs.k8s.io/kubebuilder/v3 v3.0.0-rc.0 h1:FGgl/3O6kt4eKpCQR5LFMZdbYwD8jqSbw/lisIuP9FI=
1561+
sigs.k8s.io/kubebuilder/v3 v3.0.0-rc.0/go.mod h1:eVtLdWzmvL1ixDYLlVrvQe8wjpikJVoSOg5PghTk2Lw=
15621562
sigs.k8s.io/kustomize v2.0.3+incompatible h1:JUufWFNlI44MdtnjUqVnvh29rR37PQFzPbLXqhyOyX0=
15631563
sigs.k8s.io/kustomize v2.0.3+incompatible/go.mod h1:MkjgH3RdOWrievjo6c9T245dYlB5QeXV4WCbnt/PEpU=
15641564
sigs.k8s.io/kustomize/kyaml v0.10.10 h1:caAxDDkaXZp+0kDsZVik4leFJV8LCy09PdVqpaoNeF4=

internal/cmd/operator-sdk/alpha/config3alphato3/convert_config_3-alpha_to_3.go

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,14 @@ var (
3434
versionRe = regexp.MustCompile(`version:[ ]*(?:")?3-alpha(?:")?`)
3535
)
3636

37+
type templObj struct {
38+
IsGo bool
39+
Resources []resource.Resource
40+
}
41+
3742
// convertConfig3AlphaTo3 returns cfgBytes converted to 3 iff cfgBytes is version 3-alpha.
3843
func convertConfig3AlphaTo3(cfgBytes []byte) (_ []byte, err error) {
44+
tObj := templObj{}
3945
cfgObj := make(map[string]interface{}, 5)
4046
if err := yaml.Unmarshal(cfgBytes, &cfgObj); err != nil {
4147
return nil, err
@@ -109,9 +115,12 @@ func convertConfig3AlphaTo3(cfgBytes []byte) (_ []byte, err error) {
109115
}
110116
}
111117

118+
tObj.Resources = resources
119+
tObj.IsGo = isGo
120+
112121
out := bytes.Buffer{}
113122
t := template.Must(template.New("").Parse(tmpl))
114-
if err := t.Execute(&out, resources); err != nil {
123+
if err := t.Execute(&out, tObj); err != nil {
115124
return nil, err
116125
}
117126

@@ -152,7 +161,8 @@ var getModulePath = func() (string, error) {
152161

153162
// Comment-heavy "resources" template.
154163
const tmpl = `resources:
155-
{{- range $i, $res := . }}
164+
{{- $isGo := .IsGo }}
165+
{{- range $i, $res := .Resources }}
156166
-{{- if $res.API }} api:
157167
{{- if $res.API.CRDVersion }}
158168
crdVersion: {{ $res.API.CRDVersion }}
@@ -163,8 +173,10 @@ const tmpl = `resources:
163173
# TODO(user): Uncomment the below line if this resource's CRD is namespace scoped, else delete it.
164174
# namespaced: true
165175
{{- end }}
176+
{{- if $isGo }}
166177
# TODO(user): Uncomment the below line if this resource implements a controller, else delete it.
167178
# controller: true
179+
{{- end }}
168180
{{- if $res.Domain }}
169181
domain: {{ $res.Domain }}
170182
{{- end }}

internal/cmd/operator-sdk/cli/cli.go.orig

Lines changed: 0 additions & 149 deletions
This file was deleted.

0 commit comments

Comments
 (0)