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

Remove the mention of HOME environment variable #328

Open
wants to merge 1 commit into
base: main
from

Conversation

@dsame
Copy link

@dsame dsame commented Oct 9, 2020

Why:

The variable name clashes with unix shell HOME variable and confuses the users. The related issue is actions/virtual-environments#1301

The variable is not set for all hosted images and has no means in the moment

What's being changed:

I removed the mention of the variable from the documentation

Check off the following:

  • All of the tests are passing.
  • I have reviewed my changes in staging.
The variable name clashes with unix shell standard variable and confuses the users. Moreover it is not set for all hosted images.
@welcome
Copy link

@welcome welcome bot commented Oct 9, 2020

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.

@github-actions github-actions bot added this to Triage in Docs team reviews Oct 9, 2020
@al-cheb
Copy link

@al-cheb al-cheb commented Oct 9, 2020

I think you should provide more details, because if i use the bash shell on Windows, $HOME variable is available.

@maxim-lobanov
Copy link

@maxim-lobanov maxim-lobanov commented Oct 9, 2020

cc: @alepauly @hross for review

A bit more context:

  • Initial issue was "why we set this variable on Ubuntu and MacOS but not set on Windows system"
  • This variable is not actually set by GitHub. It is set by Ubuntu and MacOS system. Since we don't set it from our side, it doesn't make much sense to describe it in doc because it can confuse. I could be wrong of course
@janiceilene janiceilene moved this from Triage to Ecosystem in Docs team reviews Oct 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Linked issues

Successfully merging this pull request may close these issues.

None yet

4 participants
You can’t perform that action at this time.