-
Notifications
You must be signed in to change notification settings - Fork 60.5k
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
Clarify nature of GITHUB_ENV/GITHUB_PATH variables #9236
Conversation
This adds a note and clarification around the explicit nature of using $GITHUB_ENV but the implicit, automatic application of $GITHUB_PATH. When reading the existing documentation, I was under the impression that these would both be applied in the same way, but the former requires explicit referencing in expression syntax whereas the latter is introduced in the shell environment automatically.
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
@davidjb Thanks so much for opening a PR! I'll get this triaged for review ⚡ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Its interesting
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Keep it up friend
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
🎉 Thanks for making this addition! I'll get this merged down for you.
@davidjb It looks like I don't have permission to resolve the merge conflict. I think if you enable the checkbox to allow maintainer edits, then I will be able to resolve this. (https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork ) Alternatively, could you resolve the merge conflict? |
@ramyaparimi the checkbox was already enabled so hopefully that’s good to go. Otherwise, I can take a look tomorrow and rebase the changes. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approving again after resolving conflicts!
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |
Why:
When reading the existing documentation at https://docs.github.com/en/actions/reference/workflow-commands-for-github-actions#setting-an-environment-variable, I was under the impression that
$GITHUB_ENV
and$GITHUB_PATH
would both be applied in the same way, both being available as environment variables within a given shell (therun
command) in subsequent steps. However, the former requires explicit referencing in expression syntax (or use of the$GITHUB_ENV
file directly) whereas the latter is introduced in the shell environment's$PATH
automatically. The docs don't currently state this; they allude to it in various other pages but not specifically spell this out.Closes #9235
What's being changed:
This adds a note and clarification around the explicit nature of using $GITHUB_ENV but the implicit, automatic application of $GITHUB_PATH.
Check off the following:
Writer impact (This section is for GitHub staff members only):