Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 68.6k
Incorrect description of GITHUB_WORKSPACE environment variable #120
Copy link
Copy link
Closed
Labels
actionsThis issue or pull request should be reviewed by the docs actions teamThis issue or pull request should be reviewed by the docs actions teamcontentThis issue or pull request belongs to the Docs Content teamThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the teamDo not begin working on this issue until triaged by the team
Description
Activity
Metadata
Metadata
Assignees
Labels
actionsThis issue or pull request should be reviewed by the docs actions teamThis issue or pull request should be reviewed by the docs actions teamcontentThis issue or pull request belongs to the Docs Content teamThis issue or pull request belongs to the Docs Content teamtriageDo not begin working on this issue until triaged by the teamDo not begin working on this issue until triaged by the team
What feature or product is affected?
GitHub Actions. Specifically the description of
GITHUB_WORKSPACEat https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variablesWe discoved this when writing github/codeql-action#54 and trying to set up a self-hosted runner.
What is the new or expected behavior?
The
GITHUB_WORKSPACEenvironment variable contains the checkout path of the repository.How is the old or inaccurate behavior currently documented?
The current documentation says "The workspace directory contains a subdirectory with a copy of your repository ..." but this is misleading or wrong. It's unclear whether "The workspace directory" is referring to
RUNNER_WORKSPACE(which exists but is undocumented) orGITHUB_WORKSPACE(the variable being documented). If the former then it's technically correct but confusing as that variable is otherwise undocumented. If the latter then it is incorrect.To fix this, just change "The workspace directory contains a subdirectory with a copy of your repository ..." to "The workspace directory a copy of your repository ..." and leave the rest unchanged.
Who does this affect?
Some small percentage of actions developers. In particular those who aim for their actions to work on self-hosted runners where the directory structure is more important.
What is the impact to users?
Largely just momentary confusion because by looking at the values of all the environment variables you can easily tell what is what and spot the error.
Content strategy and implementation
Please link any in-flight PRs to this issue.