forked from github/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request github#13276 from github/repo-sync
repo sync
- Loading branch information
Showing
3 changed files
with
43 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
40 changes: 40 additions & 0 deletions
40
...es/developing-in-codespaces/default-environment-variables-for-your-codespace.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
title: Default environment variables for your codespace | ||
shortTitle: Default environment variables | ||
product: '{% data reusables.gated-features.codespaces %}' | ||
permissions: '{% data reusables.codespaces.availability %}' | ||
intro: '{% data variables.product.prodname_dotcom %} sets default environment variables for each codespace.' | ||
versions: | ||
fpt: '*' | ||
ghec: '*' | ||
type: overview | ||
topics: | ||
- Codespaces | ||
- Fundamentals | ||
- Developer | ||
--- | ||
|
||
## About default environment variables | ||
|
||
{% data variables.product.prodname_dotcom %} sets default environment variables for every codespace. Commands run in codespaces can create, read, and modify environment variables. | ||
|
||
{% note %} | ||
|
||
**Note**: Environment variables are case-sensitive. | ||
|
||
{% endnote %} | ||
|
||
## List of default environment variables | ||
|
||
| Environment variable | Description | | ||
| ---------------------|------------ | | ||
| `CODESPACE_NAME` | The name of the codespace For example, `monalisa-github-hello-world-2f2fsdf2e` | | ||
| `CODESPACES` | Always `true` while in a codespace | | ||
| `GIT_COMMITTER_EMAIL` | The email for the "author" field of future `git` commits. | | ||
| `GIT_COMMITTER_NAME` | The name for the "committer" field of future `git` commits. | | ||
| `GITHUB_API_URL` | Returns the API URL. For example, `{% data variables.product.api_url_code %}`. | | ||
| `GITHUB_GRAPHQL_URL` | Returns the GraphQL API URL. For example, `{% data variables.product.graphql_url_code %}`. | | ||
| `GITHUB_REPOSITORY` | The owner and repository name. For example, `octocat/Hello-World`. | | ||
| `GITHUB_SERVER_URL`| Returns the URL of the {% data variables.product.product_name %} server. For example, `https://{% data variables.product.product_url %}`. | | ||
| `GITHUB_TOKEN` | A signed auth token representing the user in the codespace. You can use this to make authenticated calls to the GitHub API. For more information, see "[Authentication](/codespaces/codespaces-reference/security-in-codespaces#authentication)." | | ||
| `GITHUB_USER` | The name of the user that initiated the codespace. For example, `octocat`. | |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters