docs icon indicating copy to clipboard operation
docs copied to clipboard

clarify that `github.env` is not related to `env`

Open jsoref 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/learn-github-actions/contexts#github-context

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

The text for github.env says:

Path on the runner to the file that sets environment variables from workflow commands. This file is unique to the current step and is a different file for each step in a job. For more information, see "Workflow commands for GitHub Actions."

Two things to add:

  1. Not to be confused with env.
  2. Not available in jobs.<*>.if for the same reason that env isn't -- see https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability

Additional information

I ran into a PR where someone was trying to use github.env.foo in a jobs[*].if to work around the fact that env isn't available at this point.

jsoref avatar Mar 18 '24 16:03 jsoref

@jsoref Thank you for raising this issue! I'll get this triaged for review :sparkles: Our team will provide feedback regarding the best next steps for this issue - thanks for your patience! 💛

nguyenalex836 avatar Mar 18 '24 18:03 nguyenalex836

[maintainer edit for spammy content]

Miranda36782 avatar Mar 20 '24 10:03 Miranda36782

@jsoref Thanks again for submitting this issue!

Not to be confused with env.

I ran into a PR where someone was trying to use github.env.foo in a jobs[*].if to work around the fact that env isn't available at this point.

After reviewing with the team, we found the PR you referenced confusing github.env with env is likely an edge case. The description of github.env begins by explaining it is a path to the environment variable file, rather than a way to access the environment. For this reason, we won't be adding a note to clarify the difference between the two 💛

Not available in jobs.<*>.if for the same reason that env isn't -- see https://docs.github.com/en/actions/learn-github-actions/contexts#context-availability

Would you be able to write a workflow to test this? Your results would greatly help us determine next steps regarding this point ✨

nguyenalex836 avatar May 23 '24 18:05 nguyenalex836

This issue has been automatically closed because there has been no response to our request for more information from the original author. With only the information that is currently in the issue, we don't have enough information to take action. Please reach out if you have or find the answers we need so that we can investigate further. See this blog post on bug reports and the importance of repro steps for more information about the kind of information that may be helpful.

github-actions[bot] avatar Jun 06 '24 19:06 github-actions[bot]