Move YAML document separator to top of release manifests #799
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
I propose moving the YAML document separator inserted as part of `make-release-artifacts.sh` to the top of each manifest rather than the bottom. Having the separator at the end of the manifest results in the generated release YAML files containing an empty document at the end. Whilst this is valid YAML, it is untidy, and certain YAML tools (`yq`) have been seen to handle empty document elements badly.
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). For more information, open the CLA check for this pull request. |
xtineskim
approved these changes
Apr 8, 2022
|
Sounds good to me! |
NimJay
approved these changes
Apr 12, 2022
D-Mwanth
pushed a commit
to D-Mwanth/microservices-demo
that referenced
this pull request
Mar 6, 2024
…Platform#799) Move the YAML document separator inserted as part of `make-release-artifacts.sh` to the top of each manifest rather than the bottom. Having the separator at the end of the manifest results in the generated release YAML files containing an empty document at the end. Whilst this is valid YAML, it is untidy, and certain YAML tools (`yq`) have been seen to handle empty document elements badly.
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.
Background
I propose moving the YAML document separator inserted as part of
make-release-artifacts.shto the top of each manifest rather than the bottom.Having the separator at the end of the manifest results in the generated release YAML files containing an empty document at the end. Whilst this is valid YAML, it is untidy, and certain YAML tools (
yq) have been seen to handle empty document elements badly.Fixes
Change Summary
Moved the YAML separator
---to before each service manifest rather than afterAdditional Notes
Testing Procedure
Tested and deployed generated manifests succesfully
Related PRs or Issues