chore: Fix yaml formatter so that it only formats the config/ directory #440
Conversation
This file contains 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
hessjcg
force-pushed
the
fix-yaml-fmt
branch
from
cbacec4 to
9501a65
Compare
enocom
approved these changes
Sep 20, 2023
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.
We need to automatically format the yaml in config/ because some of it is generated
by controller-runtime and kubebuilder, some of it is hand-written. The formatter helps us
preserve the consistency and minimize noisy diffs when we upgrade the tools that generate yaml.
However, we don't want to format the hand-written yaml used elsewhere in this project as tool configuration
and example docs. The yaml formatter makes the yaml consistent, but not as readable.