Skip to content

fix: preserve original YAML formatting in resource output #6046

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
Rindrics wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix: preserve original YAML formatting in resource output #6046

Rindrics wants to merge 1 commit into from
+14 −21

Conversation

@Rindrics
Copy link

@Rindrics Rindrics commented Jan 16, 2026

What this PR does

Changes Resource.AsYAML() to use kyaml's encoder instead of sigs.k8s.io/yaml.JSONToYAML.

Why

The previous implementation had issues with:

  • Long lines being wrapped (breaking shell commands, template strings)
  • Inconsistent quote handling

Breaking changes

Quote styles are now preserved instead of being normalized. For example:

  • 'quoted_value' stays as 'quoted_value' (previously became quoted_value)

This is considered an improvement as it provides consistent, predictable output.

Related to:

@k8s-ci-robot k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 16, 2026
@linux-foundation-easycla
Copy link

linux-foundation-easycla bot commented Jan 16, 2026 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: Rindrics / name: Akira Hayashi (rin) (faaf4d2)

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Jan 16, 2026

Welcome @Rindrics!

It looks like this is your first PR to kubernetes-sigs/kustomize 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/kustomize has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 16, 2026
@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Jan 16, 2026

Hi @Rindrics. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

@k8s-ci-robot
Copy link
Contributor

k8s-ci-robot commented Jan 16, 2026

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Rindrics
Once this PR has been reviewed and has the lgtm label, please assign varshaprasad96 for approval. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Jan 16, 2026
@Rindrics Rindrics marked this pull request as ready for review January 16, 2026 02:52
@k8s-ci-robot k8s-ci-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 16, 2026
@Rindrics Rindrics force-pushed the issue-947-long-line branch from a86c62a to 3372098 Compare January 16, 2026 04:45
@Rindrics
fix: preserve original YAML formatting in resource output
faaf4d2 
Previously, Resource.AsYAML() used yaml.JSONToYAML which caused two issues:

1. Long lines were automatically wrapped at ~80 characters, breaking
   shell commands and template strings (e.g., Helm-style {{ }})
2. Quote styles were inconsistently modified - sometimes removed,
   sometimes added

This change switches to using kyaml's encoder (RNode.MustString) which
preserves the original YAML formatting, including:
- Long lines remain on a single line
- Quote styles ('single', "double", or unquoted) are preserved

This is a more consistent behavior that respects the user's original
YAML structure.

Related to:
- kubernetes-sigs#947
- kubernetes-sigs#3969
@Rindrics Rindrics force-pushed the issue-947-long-line branch from 3372098 to faaf4d2 Compare January 16, 2026 04:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@koba1t koba1t Awaiting requested review from koba1t

@varshaprasad96 varshaprasad96 Awaiting requested review from varshaprasad96

Assignees

No one assigned

Labels

cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@Rindrics @k8s-ci-robot