docs: make Stage context explicit in promotion step examples#6277
Open
MuhanedYahya wants to merge 1 commit into
Open
docs: make Stage context explicit in promotion step examples#6277MuhanedYahya wants to merge 1 commit into
MuhanedYahya wants to merge 1 commit into
Conversation
✅ Deploy Preview for docs-kargo-io ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Muhaned Yahya <muhaned.yahya@conevel.com>
b0f4435 to
31a37c3
Compare
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
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.
Issue Reference
Closes #6275
Description
Several promotion step reference examples used
${{ outputs.alias.field }}without any surrounding YAML context. This created an unstated assumption
that the reader understood the snippet to be inside a
Stage'sspec.promotionTemplate— not inside a(Cluster)PromotionTask, wherethe correct syntax is
${{ task.outputs['alias'].field }}.As noted in the original review on #6273, the fix is to make the context
explicit in each affected example rather than leaving it as an assumption.
Checklist
kind/proposal,needs discussion,needs research,maintainer only,area/security,size/large,size/x-large,size/xx-large).AI Use Disclosure
Select one:
Sign-Off
git commit -s) (required)git commit -S) (encouraged)