feat: preserve initial document separator with kyaml

[grothej]

Context

This PR aims to implement a feature requested in #5850 . The kyaml package shalloptionally be able to retain a leading document separator. As suggested by the author of the before mentioned issue the implementation is similar to the sequence indentation handling.

Content

• adding new field to configure behavior for document separator retention in ByteReadWriter + ByteReader
• checking for leading document separator
• adding metadata annotation for leading RNode in ByteReader.Read()
• append --- to the start of the io.Writer in case of annotation being present

Note

The check for a leading document separator is kept simple to avoid adding a complex regex or importing additional packages in byteio_reader.go

[k8s-ci-robot]

This PR has multiple commits, and the default merge method is: merge.
You can request commits to be squashed using the label: tide/merge-method-squash

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.

[linux-foundation-easycla]

The committers listed above are authorized under a signed CLA.

• ✅ login: grothej / name: Justin Grothe (2783128, 2f19724, 315a287, 32fbde7, 356ecbc, 73d45c6, 73d849b, 863d61c, 97173ca)

[k8s-ci-robot]

Welcome @grothej!

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]

Hi @grothej. 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]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: grothej
Once this PR has been reviewed and has the lgtm label, please assign koba1t 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:

• OWNERS

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

[grothej]

Hi @koba1t @varshaprasad96 , could you please take a look when you have a chance? Happy to address any feedback.

[koba1t]

/ok-to-test

[grothej]

/retest