Skip to content
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.

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

Re-use printer for multiple elements #2373

Merged
merged 1 commit into from
Aug 21, 2024
Merged

Conversation

lcarva
Copy link
Contributor

@lcarva lcarva commented Aug 13, 2024

Changes

Some printers contain an internal state. The YAMLPrinter, for example, tracks how many objects have been printed. When it prints an object, and it is not the first one to be printed, it prints the YAML document separator, ---. If a new printer is used when printing each object, then the YAMLPrinter always considers that it is printing the first object. This causes the YAML objects to be muddled together.

This commit makes it so a printer is re-used when printing multiple objects. For conformity, this is also done when a single object is expected to be printed, e.g. get or describe.

Fixes #2091

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

  • Includes tests (if functionality changed/added)
  • Run the code checkers with make check
  • Regenerate the manpages, docs and go formatting with make generated
  • Commit messages follow commit message best practices

See the contribution guide
for more details.

Release Notes

Fix printing of multiple YAML documents

Some printers contain an internal state. The YAMLPrinter, for example,
tracks how many objects have been printed. When it prints an object, and
it is not the first one to be printed, it prints the YAML document
separator, `---`. If a new printer is used when printing each object,
then the YAMLPrinter always considers that it is printing the first
object. This causes the YAML objects to be muddled together.

This commit makes it so a printer is re-used when printing multiple
objects. For conformity, this is also done when a single object is
expected to be printed, e.g. get or describe.

Fixes tektoncd#2091

Signed-off-by: Luiz Carvalho <lucarval@redhat.com>
@tekton-robot tekton-robot added release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 13, 2024
@tekton-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: vinamra28

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Aug 21, 2024
@piyush-garg
Copy link
Contributor

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Aug 21, 2024
@tekton-robot tekton-robot merged commit 5ad0d4d into tektoncd:main Aug 21, 2024
8 checks passed
@lcarva lcarva deleted the fix-yaml-sep branch August 21, 2024 12:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. lgtm Indicates that a PR is ready to be merged. release-note Denotes a PR that will be considered when it comes time to generate release notes. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Tkn bundle list split yamls
4 participants