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

Stop warning about HOME not being present on Windows runners #160

Closed
EndBug opened this issue Jul 6, 2023 · 4 comments
Closed

Stop warning about HOME not being present on Windows runners #160

EndBug opened this issue Jul 6, 2023 · 4 comments
Labels

Comments

@EndBug
Copy link

EndBug commented Jul 6, 2023

As of now, the toolkit is creating a warning every time the HOME env variable is not present, as it's part of the required env variables:

const requiredEnvVars = [
'HOME',
'GITHUB_WORKFLOW',
'GITHUB_ACTION',
'GITHUB_ACTOR',
'GITHUB_REPOSITORY',
'GITHUB_EVENT_NAME',
'GITHUB_EVENT_PATH',
'GITHUB_WORKSPACE',
'GITHUB_SHA'
]

A user of mine has reported here that Windows runners don't use the HOME variable, even if they are original runners from GitHub.

I think the HOME variable could be removed from the list, since it doesn't seem to be actually used by the toolkit. Also, if one really needed to work with paths, there are a lot of other variables that GitHub provides in their runners, like: GITHUB_WORKSPACE, GITHUB_ACTION_PATH, GITHUB_EVENT_PATH, GITHUB_PATH, ...

@cliffchapmanrbx
Copy link

I can confirm that my company has been using your GHA workflow and we have been seeing this warning for quite some time :)

It looks like the HOME env var is not used for anything other than tests. Indeed some time ago explicitly failing on missing env vars was reverted because valid GitHub envs omitted some of the list.

It seems like dropping HOME from that list would be safe to do, provided the tests were updated to alter a different expected env var.

@github-actions
Copy link

This issue has been inactive for awhile; please comment if it's still relevant!

@github-actions github-actions bot added the Stale label Sep 26, 2023
@EndBug
Copy link
Author

EndBug commented Sep 26, 2023

Yup

@github-actions github-actions bot closed this as completed Oct 4, 2023
@EndBug
Copy link
Author

EndBug commented Oct 4, 2023

But I did comment! >:|

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants