Skip to content

Clarify $HOME environment variable in Actions docs #21424

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.

Sign up for GitHub

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

Jump to bottom
Closed
wpbonelli opened this issue Oct 17, 2022 · 3 comments · Fixed by #21444
Closed

Clarify $HOME environment variable in Actions docs #21424

wpbonelli opened this issue Oct 17, 2022 · 3 comments · Fixed by #21444
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 waiting for review Issue/PR is waiting for a writer's review

Comments

@wpbonelli
Copy link
Contributor

Although it's been removed from the default variables table, the docs still describe $HOME as a default environment variable in the naming conventions section. This initially gave me the impression that the runner will ensure it is set in all shells on all platforms. Is it maybe worth removing mention of $HOME from the naming conventions section, or clarifying that it is Unix-specific? Happy to create a PR if that would be helpful

Originally posted by @w-bonelli in #328 (comment)
@welcome
Copy link

welcome bot commented Oct 17, 2022

Thanks for opening this issue. 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 the triage Do not begin working on this issue until triaged by the team label Oct 17, 2022
@cmwilson21
Copy link
Contributor

👋 @w-bonelli - Thanks for opening this issue! I'll get it triaged for review 👀

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team actions This issue or pull request should be reviewed by the docs actions team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Oct 17, 2022
@lucascosti
Copy link
Contributor

Thanks for pointing this out, @w-bonelli!

Is it maybe worth removing mention of $HOME from the naming conventions section

Yep, I think this is the best approach. Feel free for you (or anyone else) to open a PR! 🙇‍♂️

@lucascosti lucascosti added the help wanted Anyone is welcome to open a pull request to fix this issue label Oct 18, 2022
@wpbonelli wpbonelli mentioned this issue Oct 18, 2022
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
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 waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

📝 remove HOME mention from Actions env var naming section
4 participants
@lucascosti @wpbonelli @cmwilson21 and others