Remove the direct depedency on gopkg.in/yaml.v2.
#1027
Merged
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
gardener-robot
added
needs/review
gardener-robot-ci-3
added
reviewed/ok-to-test
* `gopkg.in/yaml.v2` was a direct dependency only because one file `internal/component/configmap/configmap.go` used it to marshal yaml. This direct depdendency is removed by replacing it with the package `sigs.k8s.io/yaml` used everywhere else in the repository to maintain consistency. * Replace `yaml` with `json` struct tags since `sigs.k8s.io/yaml` first marshals the `struct` to a json, and then yaml. When `yaml` tags are specified, the specified tags are not used when marshalling to `json`, which causes the intermediate json values to have the keys as the `struct` field names, causing the final yaml also to have the struct field names as the keys.
seshachalam-yv
approved these changes
Mar 12, 2025
There was a problem hiding this comment.
Thanks, @renormalize, for replacing the direct dependency with sigs.k8s.io/yaml!
/lgtm
/approve
gardener-robot-ci-1
added
the
reviewed/ok-to-test
This comment was marked as outdated.
This comment was marked as outdated.
gardener-robot
added
size/s
gardener-robot-ci-2
removed
the
reviewed/ok-to-test
* The general convention for fields which are `omitempty` is to make them pointers. If not, the fields will be their zero values which is not the intended marshalled output.
gardener-robot-ci-1
added
reviewed/ok-to-test
seshachalam-yv
approved these changes
Mar 12, 2025
gardener-robot
added
the
status/closed
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.
How to categorize this PR?
/area dev-productivity
/kind cleanup
What this PR does / why we need it:
gopkg.in/yaml.v2was a direct dependency only because one fileinternal/component/configmap/configmap.goused it to marshal yaml. This direct depdendency is removed by replacing it with the packagesigs.k8s.io/yamlused everywhere else in the repository to maintain consistency.Replace
yamlwithjsonstruct tags sincesigs.k8s.io/yamlfirst marshals thestructto a json, and then yaml. Whenyamltags are specified, the specified tags are not used when marshalling tojson, which causes the intermediate json values to have the keys as thestructfield names, causing the final yaml also to have the struct field names as the keys.Make
omitemptyfields pointers. The general convention for fields which areomitemptyis to make them pointers. If not, the fields will be their zero values which is not the intended marshalled output.Replace C-like for loops with range for loops for readability.
Release note: