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

Workflow commands for GitHub Actions is stale #7868

Closed
jsoref opened this issue Jul 1, 2021 · 4 comments · Fixed by #11567
Closed

Workflow commands for GitHub Actions is stale #7868

jsoref opened this issue Jul 1, 2021 · 4 comments · Fixed by #11567
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 help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@jsoref
Copy link
Contributor

jsoref commented Jul 1, 2021

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?

The following table shows which toolkit functions are available within a workflow:

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' and echo '::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.

@jsoref jsoref added the content This issue or pull request belongs to the Docs Content team label Jul 1, 2021
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jul 1, 2021
@janiceilene janiceilene added actions This issue or pull request should be reviewed by the docs actions team and removed triage Do not begin working on this issue until triaged by the team labels Jul 2, 2021
@Simran-B
Copy link
Contributor

Simran-B commented Jul 4, 2021

It might not be documented on purpose, as the recommended way for turning command echoing on is to create a secret ACTIONS_RUNNER_DEBUG with a value of true: Enable debug logging

Other commands to potentially document:

  • ::add-matcher and ::remove-matcher

Not to be documented:

  • ::internal-set-repo-path
  • ::add-path and ::set-env (deprecated)

@jsoref
Copy link
Contributor Author

jsoref commented Jul 4, 2021

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:

https://github.com/actions/runner/blob/main/docs/adrs/0280-command-input-echoing.md#context

Echo output in the user logs can be explicitly controlled by the new commands ::echo::on and ::echo::off.

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.

@lucascosti
Copy link
Contributor

Thanks for pointing this out, @jsoref!

I agree that we should document echo '::echo::on' and echo '::echo::off' as a new section in "Workflow commands for GitHub Actions"

A new section titled something like "Echoing command outputs" that describes what ::echo::on and ::echo::off do, along with examples like the existing sections. We should also mention the interaction/overlap with ACTIONS_RUNNER_DEBUG (how ACTIONS_RUNNER_DEBUG is a global setting, while these are more granular) and link to and from its section.

I'll tag this for anyone to open a PR to implement 👍

@lucascosti lucascosti added the help wanted Anyone is welcome to open a pull request to fix this issue label Jul 15, 2021
@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Oct 8, 2021
@jsoref
Copy link
Contributor Author

jsoref commented Oct 17, 2021

Apparently I missed?

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 help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

7 participants
@jsoref @lucascosti @Simran-B @janiceilene @ramyaparimi and others