-
Notifications
You must be signed in to change notification settings - Fork 60.3k
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
Workflow commands for GitHub Actions is stale #7868
Comments
It might not be documented on purpose, as the recommended way for turning command echoing on is to create a secret Other commands to potentially document:
Not to be documented:
|
In principle one is supposed to be able to turn toggle echo repeatedly (even w/in a single job step or action stage), which one couldn't do w/ the secret. Anyway, the ADR is explicit, and I'll quote it:
And as secrets apply to all workflows in a repository, it really is a very large hammer for what may be potentially a tiny nail. That said, if it shouldn't be documented, there should be an obvious place for doc writers to go to determine this. At present, I'm fairly confident no such place exists. |
Thanks for pointing this out, @jsoref! I agree that we should document A new section titled something like "Echoing command outputs" that describes what I'll tag this for anyone to open a PR to implement 👍 |
Apparently I missed? |
What article on docs.github.com is affected?
https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#using-workflow-commands-to-access-toolkit-functions
What part(s) of the article would you like to see updated?
Additional information
The table isn't complete.
At the very least, it's missing:
https://github.com/actions/runner/blob/main/docs/adrs/0280-command-input-echoing.md
which added
echo '::echo::on'
andecho '::echo::off'
.It is probably missing a number of other things. It'd be nice if someone interviewed the team and got the documents current.
The text was updated successfully, but these errors were encountered: