Skip to content

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

Merged
EronWright merged 2 commits into
akuity:mainfrom
MuhanedYahya:docs/fix-outputs-context-in-promotion-step-examples
Jul 7, 2026
Merged

docs: make Stage context explicit in promotion step examples#6277
EronWright merged 2 commits into
akuity:mainfrom
MuhanedYahya:docs/fix-outputs-context-in-promotion-step-examples

Conversation

@MuhanedYahya

@MuhanedYahya MuhanedYahya commented May 13, 2026

Copy link
Copy Markdown
Contributor

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

netlify Bot commented May 13, 2026

Copy link
Copy Markdown

Deploy Preview for docs-kargo-io ready!

Name Link
🔨 Latest commit 37037b9
🔍 Latest deploy log https://app.netlify.com/projects/docs-kargo-io/deploys/6a42e566d41e67000840118b
😎 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.

@MuhanedYahya MuhanedYahya force-pushed the docs/fix-outputs-context-in-promotion-step-examples branch from b0f4435 to 31a37c3 Compare May 13, 2026 20:56
@MuhanedYahya

Copy link
Copy Markdown
Contributor Author

@krancour any updates? i see a conflict in docs which wasn't there when i first forked the repo

MuhanedYahya and others added 2 commits June 29, 2026 11:32
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>
@EronWright EronWright force-pushed the docs/fix-outputs-context-in-promotion-step-examples branch from 31a37c3 to 37037b9 Compare June 29, 2026 21:36
@EronWright EronWright requested a review from krancour June 29, 2026 22:14
@EronWright

Copy link
Copy Markdown
Contributor

Summary of changes — consolidation of #6275 work

For 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:

  • Every output-referencing example now shows the explicit Stage context and carries the inline # Or task.outputs in a (Cluster)PromotionTask pointer.
  • The pointer was extended across all the reference pages identified in the discussion: gha-wait-for-workflow, git-commit, jfrog-evidence, jira, oci-push, and send-message.
  • For the message: | block-scalar case in git-commit, the comment sits on the | indicator line so it isn't absorbed into the literal commit message.
  • Pages whose examples are already framed as (Cluster)PromotionTask (compose-output, snow-*, tf-plan) already use task.outputs correctly and were left untouched.

@AndresGuido9820's contribution is preserved via a Co-authored-by trailer, and #6284 has been closed in favor of this PR.

Status: rebased clean (MERGEABLE), CI green. Ready for review @krancour.

@codecov

codecov Bot commented Jun 29, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.63%. Comparing base (45616df) to head (37037b9).
⚠️ Report is 2 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@hairyhum hairyhum left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@EronWright EronWright added this pull request to the merge queue Jul 7, 2026
Merged via the queue into akuity:main with commit a6ace68 Jul 7, 2026
20 checks passed
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

4 participants