docs: make Stage context explicit in promotion step examples#6277
Conversation
✅ Deploy Preview for docs-kargo-io ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
b0f4435 to
31a37c3
Compare
|
@krancour any updates? i see a conflict in docs which wasn't there when i first forked the repo |
Signed-off-by: Muhaned Yahya <muhaned.yahya@conevel.com>
Builds on the explicit Stage context by folding in the approach from akuity#6284: each promotion-step example that references a previous step's outputs now also carries an inline "# Or task.outputs in a (Cluster)PromotionTask" pointer, and the remaining reference pages that use step outputs (gha-wait-for-workflow, git-commit, jfrog-evidence, jira, oci-push, send-message) are wrapped in the same Stage context. Where an output reference sits inside a multi-line ${{ quote({...}) }} expression, the inline pointer is omitted (it would break the expression); the Stage context alone disambiguates there. Also fixes a "Promoteing" typo in the jira example. Closes akuity#6275 Co-authored-by: Andres <aguido@unal.edu.co> Signed-off-by: Eron Wright <eron.wright@akuity.io>
31a37c3 to
37037b9
Compare
Summary of changes — consolidation of #6275 workFor context on how this PR evolved: there were two PRs addressing #6275 from slightly different angles:
Since both edit the same example files, they couldn't both land. So both approaches have been consolidated here:
@AndresGuido9820's contribution is preserved via a Status: rebased clean ( |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6277 +/- ##
==========================================
- Coverage 58.63% 58.63% -0.01%
==========================================
Files 505 505
Lines 42691 42691
==========================================
- Hits 25033 25031 -2
- Misses 16124 16125 +1
- Partials 1534 1535 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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)