Skip to content

docs: make Stage context explicit in promotion step examples#6277

Open
MuhanedYahya wants to merge 1 commit into
akuity:mainfrom
MuhanedYahya:docs/fix-outputs-context-in-promotion-step-examples
Open

docs: make Stage context explicit in promotion step examples#6277
MuhanedYahya wants to merge 1 commit into
akuity:mainfrom
MuhanedYahya:docs/fix-outputs-context-in-promotion-step-examples

Conversation

@MuhanedYahya
Copy link
Copy Markdown

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's
spec.promotionTemplate — not inside a (Cluster)PromotionTask, where
the 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

  • The PR is linked to an existing issue.
  • The linked issue has no blocking labels (kind/proposal,
    needs discussion, needs research, maintainer only, area/security,
    size/large, size/x-large, size/xx-large).
  • I have added or updated tests as appropriate.
  • I have added or updated documentation as appropriate.

AI Use Disclosure

Select one:

  • This PR was written by a human without AI assistance.
  • This PR was written by a human with AI assistance. A human has reviewed every line prior to opening the PR.
  • This PR was written by an AI with human supervision. A human has reviewed every line prior to opening the PR.
  • This PR was written entirely by AI. No human has reviewed this prior to opening the PR.

Sign-Off

  • All commits are signed off (git commit -s) (required)
  • All commits are cryptographically signed (git commit -S) (encouraged)

@MuhanedYahya MuhanedYahya requested review from a team as code owners May 13, 2026 20:52
@netlify
Copy link
Copy Markdown

netlify Bot commented May 13, 2026

Deploy Preview for docs-kargo-io ready!

Name Link
🔨 Latest commit 31a37c3
🔍 Latest deploy log https://app.netlify.com/projects/docs-kargo-io/deploys/6a04e571f38b3100086c0b85
😎 Deploy Preview https://deploy-preview-6277.docs.kargo.io
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Signed-off-by: Muhaned Yahya <muhaned.yahya@conevel.com>
@MuhanedYahya MuhanedYahya force-pushed the docs/fix-outputs-context-in-promotion-step-examples branch from b0f4435 to 31a37c3 Compare May 13, 2026 20:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs bug: fix unstated assumption inherent in many examples

2 participants