Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarifies outputs in reusable workflows #32544

Merged
merged 4 commits into from
May 31, 2024
Merged

Conversation

APCBoston
Copy link
Contributor

@APCBoston APCBoston commented Apr 16, 2024

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 data directory.

  • [ x ] For content changes, I have completed the self-review checklist.

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.
Copy link

welcome bot commented Apr 16, 2024

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 github-actions bot added the triage Do not begin working on this issue until triaged by the team label Apr 16, 2024
Copy link
Contributor

github-actions bot commented Apr 16, 2024

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 that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You 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.

Source Preview Production What Changed
actions/using-workflows/reusing-workflows.md fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9
fpt
ghec
ghes@ 3.13 3.12 3.11 3.10 3.9

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@nguyenalex836
Copy link
Contributor

@APCBoston Thanks so much for opening a PR! I'll get this triaged for review ✨

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Apr 16, 2024
Copy link
Contributor

@jc-clark jc-clark left a comment

Choose a reason for hiding this comment

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

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?

content/actions/using-workflows/reusing-workflows.md Outdated Show resolved Hide resolved
@nguyenalex836 nguyenalex836 added more-information-needed More information is needed to complete review and removed waiting for review Issue/PR is waiting for a writer's review labels May 30, 2024
Accepts suggestion from @jc-clark

Co-authored-by: Joe Clark <31087804+jc-clark@users.noreply.github.com>
@APCBoston
Copy link
Contributor Author

@jc-clark your latest suggestion works for me and I have accepted it!

Copy link
Contributor

@jc-clark jc-clark left a comment

Choose a reason for hiding this comment

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

Thanks for working with me on this on @APCBoston and for contributing to the docs! 🪄

@jc-clark jc-clark added this pull request to the merge queue May 31, 2024
Merged via the queue into github:main with commit 8ef13b0 May 31, 2024
44 checks passed
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
actions This issue or pull request should be reviewed by the docs actions team content This issue or pull request belongs to the Docs Content team more-information-needed More information is needed to complete review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Lack of clarity re: reusable workflow outputs
3 participants