docs icon indicating copy to clipboard operation
docs copied to clipboard

ACTIONS_RUNNER_PRINT_LOG_TO_STDOUT should be described with example usage

Open mcarans opened this issue 2 years ago • 4 comments

Code of Conduct

What article on docs.github.com is affected?

https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions

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

ACTIONS_RUNNER_PRINT_LOG_TO_STDOUT is not documented in the GitHub Actions documentation and should be clearly described along with examples of how and where to set it. If jobs.<job_id>.environment is the correct place to set it, then it should be added there. If not, then it should be added in the appropriate article and place.

From https://github.com/actions/runner/issues/891#issuecomment-1398565763, "As of v2.300.0, setting ACTIONS_RUNNER_PRINT_LOG_TO_STDOUT to 1 or true will also print the logs to stdout in addition to the logfile."

ACTIONS_RUNNER_PRINT_LOG_TO_STDOUT may be something that supports the use cases described by many users in the following issues: https://github.com/actions/runner/issues/886, https://github.com/actions/runner/issues/891, https://github.com/actions/runner/issues/2131 and the following discussions: https://github.com/orgs/community/discussions/35363, https://github.com/orgs/community/discussions/44250. Without documentation of ACTIONS_RUNNER_PRINT_LOG_TO_STDOUT, it's hard to know what it is meant to do, what exactly it will output or how to use it.

Additional information

No response

mcarans avatar Apr 17 '23 01:04 mcarans

Thanks for the issue @mcarans, I'll get this triaged for review!

steveward avatar Apr 17 '23 19:04 steveward

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Apr 28 '23 21:04 github-actions[bot]

This is a gentle bump for the docs team that this issue is waiting for technical review.

github-actions[bot] avatar May 27 '23 16:05 github-actions[bot]

This is a gentle bump for the docs team that this issue is waiting for technical review.

github-actions[bot] avatar Jun 28 '23 16:06 github-actions[bot]

This is a gentle bump for the docs team that this issue is waiting for technical review.

github-actions[bot] avatar Jul 28 '23 16:07 github-actions[bot]

This is a gentle bump for the docs team that this issue is waiting for technical review.

github-actions[bot] avatar Aug 28 '23 16:08 github-actions[bot]

Thanks for opening an issue! We've triaged this issue for technical review by a subject matter expert :eyes:

github-actions[bot] avatar Aug 29 '23 13:08 github-actions[bot]

This is a gentle bump for the docs team that this issue is waiting for technical review.

github-actions[bot] avatar Sep 26 '23 16:09 github-actions[bot]

Hey @mcarans thank you for your patience as we work through our backlog of reviews.

I've chatted with the team about your request for documentation about the ACTIONS_RUNNER_PRINT_LOG_TO_STDOUT parameter, and we've decided to continue the discussion about these doc updates internally. Thanks so much for sharing your experience and related information about use cases ✨. I have copied the details of this issue to an internal issue where we'll work on things, so I'll close this issue now.

Thanks again for your work and your interest in improving GitHub's documentation! 💛

vgrl avatar Oct 02 '23 23:10 vgrl