Introducing a generator configuration for GoTag customization #485
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
a-hilaly
force-pushed
the
gotag-config
branch
2 times, most recently
from
359c560 to
143e03b
Compare
This patch introduces a new configuration, `go_tag`, to allow ACK developers to customize the "Go tags" in the generated structures. With this configuration users can easily override the default Go tags, making adjustements like changing the tag name, adding omitempty directives or even introducing new ones (yaml, gorm, protobuf etc). This change helps ACK users overcome the challenge imposed by our names utility package (`aws-controllers-k8s/pkg/names/`) which adds an underscore suffix to field names that matches Golang keywords. Resulting in an odd UX when consuming the generated ACK CRDs (e.g using `type_: <...>` instead of `type: <...>`) We purposefully avoided directly modifying the `names` utility package (trimming the underscores when generating the go tags) as it will break compatibility with the already existing CRDs (yep we missed this). Without some sort of mutating webhooks that will handle field renames, we'll avoid going that route, and instead start using `go_tag` configs for future CRDs/fields. This patch will help in tweaking the generated code for aws-controllers-k8s/eks-controller#84 Signed-off-by: Amine Hilaly <[email protected]>
a-hilaly
force-pushed
the
gotag-config
branch
from
143e03b to
f108e30
Compare
|
/hold |
ack-prow
bot
added
the
do-not-merge/hold
acornett21
approved these changes
Jan 10, 2024
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: a-hilaly, acornett21, jonathan-innis The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/retest |
|
experiencing some etcd timeouts with the ec2-controller, restarting to see if it's consistent |
|
/unhold |
ack-prow
bot
removed
the
do-not-merge/hold
|
/test all |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch introduces a new configuration,
go_tag, to allow ACKdevelopers to customize the "Go tags" in the generated structures.
With this configuration users can easily override the default Go tags,
making adjustements like changing the tag name, adding omitempty
directives or even introducing new ones (yaml, gorm, protobuf etc).
This change helps ACK users overcome the challenge imposed by our names
utility package (
aws-controllers-k8s/pkg/names/) which adds anunderscore suffix to field names that matches Golang keywords. Resulting
in an odd UX when consuming the generated ACK CRDs (e.g using
type_: <...>instead oftype: <...>)We purposefully avoided directly modifying the
namesutility package(trimming the underscores when generating the go tags) as it will break
compatibility with the already existing CRDs (yep we missed this).
Without some sort of mutating webhooks that will handle field renames,
we'll avoid going that route, and instead start using
go_tagconfigsfor future CRDs/fields.
This patch will help in tweaking the generated code for
aws-controllers-k8s/eks-controller#84
Signed-off-by: Amine Hilaly [email protected]
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.