[go: nahoru, domu]
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.

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

Consider allowing for "comment only" YAML documents in package parser #356

Open
hasheddan opened this issue Sep 26, 2022 · 2 comments
Open

Consider allowing for "comment only" YAML documents in package parser #356

hasheddan opened this issue Sep 26, 2022 · 2 comments
Assignees
@hasheddan
Labels
enhancement New feature or request

Comments

@hasheddan
Copy link
Member

What problem are you facing?

Currently, the package parser will ignore empty YAML documents and those that only contain whitespace. However, it does not accommodate for a YAML document that contains content which is only comments (which is effectively the same as the previous two document scenarios).

How could Crossplane help solve your problem?

We should consider allowing for "comment only" documents in packages and skipping them during parsing.
@hasheddan hasheddan added the enhancement New feature or request label Sep 26, 2022
@hasheddan hasheddan self-assigned this Sep 26, 2022
This was referenced Sep 26, 2022
Closed
Merged
@luebken
Copy link
luebken commented Sep 27, 2022

Relevant Yaml spec:
https://yaml.org/spec/1.0/#id2561718

... A document header line may be used to start a document ...

@hasheddan
Copy link
Member Author

@luebken to be clear, this is not due to a leading document header, but rather due to the fact that there is a complete document that only contains comment data. The xpkg specification restricts what can be included in a package. We currently also allow for "empty documents", but a document full of comments is not empty, which is why this scenario results in rejection.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hasheddan hasheddan

Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@luebken @hasheddan