Description
What feature or product is affected?
GitHub Actions. Specifically the description of GITHUB_WORKSPACE at https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables
We 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_WORKSPACE environment 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) or GITHUB_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
| Item | Core | DSP | Ecosystem/API |
|---|---|---|---|
| Unified content strategy plan |
Please link any in-flight PRs to this issue.