docs icon indicating copy to clipboard operation
docs copied to clipboard

Lack of clarity re: reusable workflow `outputs`

Open APCBoston opened this issue 1 year ago • 2 comments
trafficstars

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/using-workflows/reusing-workflows#using-outputs-from-a-reusable-workflow

What part(s) of the article would you like to see updated?

The existing text is not clear that the workflow level outputs: may be mapped to job-level, but not step-level outputs. The example workflow maps step-level outputs to job-level outputs, then to workflow-level outputs, but the text does not explain that this is needed and that attempting to map workflow-level outputs directly to step-level outputs won't work. Attempts to use step-level outputs do not generate an error but pass an empty output to the caller, compounding the confusion.

Additional information

A proposed clarification will follow momentarily in the form of a PR.

APCBoston avatar Apr 16 '24 16:04 APCBoston

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

welcome[bot] avatar Apr 16 '24 16:04 welcome[bot]

@APCBoston Thank you for opening an issue and linking it to your PR! ✨

nguyenalex836 avatar Apr 16 '24 17:04 nguyenalex836