update docs/stacker_yaml.md #650
Merged
Conversation
This file contains hidden or 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
- reorganize slightly for better readability - give more examples of valid urls for type 'tar', based on what the code supports. - clarify that the type: oci does not require that the url starts with `oci:`, in fact that will make it fail unless your oci layout is named `oci`, because in pkg/types/imagesource.go ContainersImageURL() prepends `oci:` to the url field of type: oci imagesource structs. Signed-off-by: Michael McCracken <[email protected]>
move the extensive commentary on substitution to the end, it was a bit much to overexplain that right at the start, my bad. add a basic common example stacker yaml right at the start so people know what we are talking about. Signed-off-by: Michael McCracken <[email protected]>
mikemccracken
requested review from
hallyn,
rchincha and
smoser
as code owners
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #650 +/- ##
==========================================
+ Coverage 54.00% 63.67% +9.66%
==========================================
Files 57 57
Lines 6175 5018 -1157
==========================================
- Hits 3335 3195 -140
+ Misses 2194 1177 -1017
Partials 646 646 ☔ View full report in Codecov by Sentry. |
hallyn
approved these changes
Oct 29, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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 type of PR is this?
documentation
Which issue does this PR fix:
reorganize stacker_yaml.md slightly for better readability
give more examples of valid urls for type 'tar', based on what the code supports.
clarify that the type: oci does not require that the url starts with
oci:, in fact that will make it fail unless your oci layout is namedoci, because in pkg/types/imagesource.go ContainersImageURL() prependsoci:to the url field of type: oci imagesource structs.What does this PR do / Why do we need it:
updates docs
If an issue # is not available please add repro steps and logs showing the issue:
Testing done on this change:
you only live once
Automation added to e2e:
no
Will this break upgrades or downgrades?
no
Does this PR introduce any user-facing change?:
no
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.