Clarify in docs that schemaType isn't supported on porter.yaml #2349
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 had originally documented that schemaType was supported on porter.yaml files but then forgot to add it to the manifest data structure (since it's not actually used, it's just a planned helper field for VS Code autocomplete in the future). When `schemaType: Bundle` is set in porter.yaml, it causes the manifest to fail validation. Since this isn't a showstopping problem, more of too eager documentation, I am updating the documentation for porter.yaml to clarify that schemaType isn't supported yet. Post v1, we can fix this bug in a patch. Signed-off-by: Carolyn Van Slyck <[email protected]>
VinozzZ
approved these changes
Sep 9, 2022
Signed-off-by: Carolyn Van Slyck <[email protected]>
Signed-off-by: Carolyn Van Slyck <[email protected]>
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.
What does this change
I had originally documented that schemaType was supported on porter.yaml files but then forgot to add it to the manifest data structure (since it's not actually used, it's just a planned helper field for VS Code autocomplete in the future).
When
schemaType: Bundleis set in porter.yaml, it causes the manifest to fail validation.Since this isn't a showstopping problem, more of too eager documentation, I am updating the documentation for porter.yaml to clarify that schemaType isn't supported yet.
Post v1, we can fix this bug in a patch.
What issue does it fix
Doc fix for #2348. Final fix will come post v1.
Notes for the reviewer
N/A
Checklist
Reviewer Checklist