Clarifies outputs in reusable workflows #32544
Conversation
The existing text is not clear that the workflow level `outputs:` may be mapped to job-level, but not step-level outputs. Attempts to use step-level outputs do not generate an error but pass an empty output. I have added two sentences to clarify that only job-level outputs may be mapped to workflow outputs.
|
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
github-actions
bot
added
the
triage
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team |
|
@APCBoston Thanks so much for opening a PR! I'll get this triaged for review ✨ |
nguyenalex836
added
content
There was a problem hiding this comment.
Hey @APCBoston, thank you for making this update! I dug around a little bit and noticed that "Defining outputs for jobs" specifically calls out setting outputs within a job:
You can use jobs.<job_id>.outputs to create a map of outputs for a job.
So what do you think about this suggested change here that links directly to the defining outputs article?
nguyenalex836
added
more-information-needed
Accepts suggestion from @jc-clark Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
|
@jc-clark your latest suggestion works for me and I have accepted it! |
There was a problem hiding this comment.
Thanks for working with me on this on @APCBoston and for contributing to the docs! 🪄
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
Closes: #32543
The existing text is not clear that the workflow level
outputs:may be mapped to job-level, but not step-level outputs. Attempts to use step-level outputs do not generate an error but pass an empty output. I have added two sentences to clarify that only job-level outputs may be mapped to workflow outputs.What's being changed (if available, include any code snippets, screenshots, or gifs):
Two sentences at the end of the section https://docs.github.com/en/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow. The diff should be very clear.
Check off the following:
[ x ] I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the
datadirectory.[ x ] For content changes, I have completed the self-review checklist.