Fix generated comments to reflect azure-service-operator #1570
Conversation
theunrepentantgeek
requested review from
babbageclunk,
davefellows,
matthchr and
Porges
as code owners
|
|
||
| // Required for backward compatibility. | ||
| // Presence of any one string will result in the file being treated as a generated file that we are responsible for | ||
| CodeGenerationCommentsDeprecated []string = []string{ |
There was a problem hiding this comment.
Is the plan to delete this later?
Feels like we should maybe just delete this now and tell the 3 or 4 of us to manually clean up the directory once when we pull? Cleaner than having legacy here before we're even released?
There was a problem hiding this comment.
Yeah, didn't take a lot to persuade me. 😁
| @@ -8,7 +8,14 @@ package astmodel | |||
| var ( | |||
| CodeGenerationComments []string = []string{ | |||
| // Note that this format is actually an official specification in go: https://github.com/golang/go/issues/13560 | |||
| "// Code generated by k8s-infra. DO NOT EDIT.", // TODO: Update this when the generated is moved/renamed | |||
| "// Code generated by azure-service-operator. DO NOT EDIT.", // TODO: Update this when the generated is moved/renamed | |||
There was a problem hiding this comment.
Maybe remove the TODO? Although I guess we still want to update it if it's moved again.
There was a problem hiding this comment.
I agree - remove TODO. I think the TODO was in reference to what @theunrepentantgeek just did (i.e. that it shouldn't say k8sinfra)
There was a problem hiding this comment.
Nah, that TODO has been there for ages. I'll remove it though.
| @@ -8,7 +8,14 @@ package astmodel | |||
| var ( | |||
| CodeGenerationComments []string = []string{ | |||
| // Note that this format is actually an official specification in go: https://github.com/golang/go/issues/13560 | |||
| "// Code generated by k8s-infra. DO NOT EDIT.", // TODO: Update this when the generated is moved/renamed | |||
| "// Code generated by azure-service-operator. DO NOT EDIT.", // TODO: Update this when the generated is moved/renamed | |||
There was a problem hiding this comment.
IMO we should differentiate between ASO and the tool that generates aso.
Maybe this is ASO-gen or something?
There was a problem hiding this comment.
Changed to azure-service-operator-codegen.
…/azure-service-operator into fix/generated-code-cleanup
Codecov Report
@@ Coverage Diff @@
## master #1570 +/- ##
=======================================
Coverage 63.43% 63.43%
=======================================
Files 181 181
Lines 11796 11796
=======================================
Hits 7483 7483
Misses 3644 3644
Partials 669 669
Continue to review full report at Codecov.
|
What this PR does / why we need it:
Our generated code had comments indicating the source was
k8s-infraandk8s-infra-gen- we change these to readazure-service-operatorwhile retaining the ability to detect and clean up generated code from older versions.How does this PR make you feel:
