Title: Incorrect description of GITHUB_WORKSPACE environment variable · Issue #120 · github/docs · GitHub
Open Graph Title: Incorrect description of GITHUB_WORKSPACE environment variable · Issue #120 · github/docs
X Title: Incorrect description of GITHUB_WORKSPACE environment variable · Issue #120 · github/docs
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 d...
Open Graph 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-vari...
X 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-vari...
Opengraph URL: https://github.com/github/docs/issues/120
X: @github
Domain: github.com
{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"Incorrect description of GITHUB_WORKSPACE environment variable","articleBody":"### What feature or product is affected?\r\n\r\nGitHub Actions. Specifically the description of `GITHUB_WORKSPACE` at https://help.github.com/en/actions/configuring-and-managing-workflows/using-environment-variables#default-environment-variables\r\n\r\nWe discoved this when writing https://github.com/github/codeql-action/pull/54 and trying to set up a self-hosted runner.\r\n\r\n### What is the new or expected behavior?\r\n\r\nThe `GITHUB_WORKSPACE` environment variable contains the checkout path of the repository.\r\n\r\n### How is the old or inaccurate behavior currently documented?\r\n\r\nThe 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.\r\n\r\nTo 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.\r\n\r\n### Who does this affect?\r\n\r\nSome 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.\r\n\r\n### What is the impact to users?\r\n\r\nLargely 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.\r\n\r\n\u003c!-- The sections below are for the Product Documentation team only. Thank you! --\u003e\r\n\r\n### Content strategy and implementation\r\n\r\n\u003c!-- To the writer who works on content strategy, please start with the [content strategy template](https://docs.google.com/document/d/1fq_jYI8jD5z22wNxNYgObqQ1_0L_emViQex67S-HfQ0/edit#) --\u003e\r\n\r\n| Item | Core | DSP | Ecosystem/API |\r\n| --- | --- | --- | --- |\r\n| Unified content strategy plan | | | |\r\n\r\n**Please link any in-flight PRs to this issue.**\r\n","author":{"url":"https://github.com/robertbrignull","@type":"Person","name":"robertbrignull"},"datePublished":"2020-06-09T09:10:33.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":0},"url":"https://github.com/120/docs/issues/120"}
| route-pattern | /_view_fragments/issues/show/:user_id/:repository/:id/issue_layout(.:format) |
| route-controller | voltron_issues_fragments |
| route-action | issue_layout |
| fetch-nonce | v2:3fc28612-bc4e-74ce-5b23-b0d508bf03fc |
| current-catalog-service-hash | 81bb79d38c15960b92d99bca9288a9108c7a47b18f2423d0f6438c5b7bcd2114 |
| request-id | BD50:2A1D55:179E9AD:2251400:6A5629C1 |
| html-safe-nonce | 5c13b3b6792e2b6be635031e12168491a7c2e2c550303d2882f3f09e58e88351 |
| visitor-payload | eyJyZWZlcnJlciI6IiIsInJlcXVlc3RfaWQiOiJCRDUwOjJBMUQ1NToxNzlFOUFEOjIyNTE0MDA6NkE1NjI5QzEiLCJ2aXNpdG9yX2lkIjoiODI3OTg3MTczOTIyNTU4MjAxNyIsInJlZ2lvbl9lZGdlIjoiaWFkIiwicmVnaW9uX3JlbmRlciI6ImlhZCJ9 |
| visitor-hmac | 9aaea92671a96243b5c4aefba3f2ce47336d6d919c4f511486f94ec36f7c44a5 |
| hovercard-subject-tag | issue:716044937 |
| github-keyboard-shortcuts | repository,issues,copilot |
| google-site-verification | Apib7-x98H0j5cPqHWwSMm6dNU4GmODRoqxLiDzdx9I |
| octolytics-url | https://collector.github.com/github/collect |
| analytics-location | / |
| fb:app_id | 1401488693436528 |
| apple-itunes-app | app-id=1477376905, app-argument=https://github.com/_view_fragments/issues/show/github/docs/120/issue_layout |
| twitter:image | https://opengraph.githubassets.com/dc6bcb5eb2801bd57fc7cbcc3f618c1164bdf3647aea5aaacb2032b969ab21d7/github/docs/issues/120 |
| twitter:card | summary_large_image |
| og:image | https://opengraph.githubassets.com/dc6bcb5eb2801bd57fc7cbcc3f618c1164bdf3647aea5aaacb2032b969ab21d7/github/docs/issues/120 |
| og:image:alt | 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-vari... |
| og:image:width | 1200 |
| og:image:height | 600 |
| og:site_name | GitHub |
| og:type | object |
| og:author:username | robertbrignull |
| hostname | github.com |
| expected-hostname | github.com |
| None | 9d78ea552aac0685ca5f006d44f88166cbbf3bb96843f8da0c5a2c0b9908430b |
| turbo-cache-control | no-preview |
| go-import | github.com/github/docs git https://github.com/github/docs.git |
| octolytics-dimension-user_id | 9919 |
| octolytics-dimension-user_login | github |
| octolytics-dimension-repository_id | 189621607 |
| octolytics-dimension-repository_nwo | github/docs |
| octolytics-dimension-repository_public | true |
| octolytics-dimension-repository_is_fork | false |
| octolytics-dimension-repository_network_root_id | 189621607 |
| octolytics-dimension-repository_network_root_nwo | github/docs |
| turbo-body-classes | logged-out env-production page-responsive |
| disable-turbo | false |
| browser-stats-url | https://api.github.com/_private/browser/stats |
| browser-errors-url | https://api.github.com/_private/browser/errors |
| release | 160a6fceec0fef718a0c3ac46f2d71ae9d5c0ff5 |
| ui-target | full |
| theme-color | #1e2327 |
| color-scheme | light dark |
Links:
Viewport: width=device-width