Skip to content

Commit 0e87509

Browse files
authored
Codespaces: more renaming of secrets to development environment secrets (#47833)
1 parent c97965b commit 0e87509

17 files changed

Lines changed: 40 additions & 40 deletions

content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -117,17 +117,17 @@ If you want to use Git hooks for your codespace, then you should set up hooks us
117117

118118
## Recommended secrets
119119

120-
The names of user-defined secrets may be displayed on the advanced options page when you create a codespace. This will happen if recommended secrets have been specified in the dev container configuration you have selected.
120+
The names of user-defined secrets may be displayed on the advanced options page when you create a codespace. This will happen if recommended secrets have been specified in the dev container configuration you have selected. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/specifying-recommended-secrets-for-a-repository)."
121121

122122
<img src="/assets/images/help/codespaces/recommended-secrets.png" style="max-height:50rem" alt='Screenshot of the "Create codespace" page with four recommended secrets highlighted with a dark orange outline.' />
123123

124-
Entering values for these secrets, when you're prompted to do so, is recommended because it's likely your project will need values for these secrets. However, supplying values is not required for you to create a codespace. You can set these secrets within the codespace if you prefer.
124+
Entering values for these development environment secrets, when you're prompted to do so, is recommended because it's likely your project will need values for these secrets. However, supplying values is not required for you to create a codespace. You can set these secrets within the codespace if you prefer.
125125

126126
If you enter a value for a recommended secret, the secret will available in the new codespace. When you click **Create codespace**, the secret is also added to your personal settings for {% data variables.product.prodname_codespaces %}, so you will not need to enter a value for the secret in future when you create a codespace for this repository.
127127

128128
If the name of a secret is shown with a checkbox that is unavailable for selection, and no input box, this is because you already have a secret of this name configured in your personal settings for {% data variables.product.prodname_codespaces %}, and you have associated it with this repository. If you've created a secret of this name but have not associated it with this repository, the checkbox will be available to select and by doing so you can update your settings to add the association.
129129

130-
If you want to change the value of a preselected secret you can do so from your personal settings for {% data variables.product.prodname_codespaces %} at [github.com/settings/codespaces](https://github.com/settings/codespaces). For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces)."
130+
If you want to change the value of a preselected secret you can do so from your personal settings for {% data variables.product.prodname_codespaces %} at [github.com/settings/codespaces](https://github.com/settings/codespaces). For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)."
131131

132132
{% endwebui %}
133133

content/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,7 @@ When a codespace is published, you have access to a greater range of options to
8383

8484
- Change the machine type of your codespace to make sure you're using resources appropriate for the work you're doing (see "[AUTOTITLE](/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace)").
8585
- Allow {% data variables.product.prodname_dotcom %} to automatically use GPG to sign commits you make in your codespace (see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)").
86-
- Share secrets with your codespace (see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces)").
86+
- Share secrets with your codespace (see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)").
8787

8888
### Publishing from {% data variables.product.prodname_dotcom_the_website %}
8989

content/codespaces/developing-in-a-codespace/persisting-environment-variables-and-temporary-files.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ There are three ways that you can set persistent custom environment variables fo
3232

3333
- You can edit the `devcontainer.json` configuration file for the repository
3434
- You can use a custom Dockerfile
35-
- You can use secrets
35+
- You can use development environment secrets
3636

3737
#### Edit the `devcontainer.json` configuration file for the repository
3838

@@ -46,7 +46,7 @@ Edit the `devcontainer.json` configuration file for the repository, and use the
4646
}
4747
```
4848

49-
Only use this method for values that you are happy to commit to your repository as plaintext. For sensitive values such as access tokens, use secrets.
49+
Only use this method for values that you are happy to commit to your repository as plaintext. For sensitive values such as access tokens, use development environment secrets.
5050

5151
The environment variable will be set within your editor's remote server process, and will be available for sub-processes of that remote server process, such as terminals and debugging sessions. However, the variable will not be available more broadly inside the container. This method is useful if you don't need the environment variable to be set for other background processes that run at startup, and if you are using a premade image and don't have or want a custom Dockerfile.
5252

@@ -60,9 +60,9 @@ This method is useful if you already have a Dockerfile and want to set a variabl
6060

6161
This setting will take effect when you rebuild your container or create a new codespace after pushing this change to the repository. For more information about applying configuration changes to a codespace, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)."
6262

63-
#### Use secrets
63+
#### Use development environment secrets
6464

65-
You can use secrets for {% data variables.product.prodname_github_codespaces %} to set custom variables for codespaces created for the repository. For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces)."
65+
You can use development environment secrets for {% data variables.product.prodname_github_codespaces %} to set custom variables for codespaces created for the repository. For more information, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)."
6666

6767
You should use this method for environment variable values that you do not want to commit to the repository as plaintext.
6868

content/codespaces/guides.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,12 +41,12 @@ includeGuides:
4141
- /codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces
4242
- /codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces
4343
- /codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces
44-
- /codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces
44+
- /codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces
4545
- /codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces
4646
- /codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces
4747
- /codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization
4848
- /codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization
49-
- /codespaces/managing-codespaces-for-your-organization/managing-secrets-for-your-repository-and-organization-for-github-codespaces
49+
- /codespaces/managing-codespaces-for-your-organization/managing-development-environment-secrets-for-your-repository-or-organization
5050
- /codespaces/managing-codespaces-for-your-organization/restricting-access-to-machine-types
5151
- /codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces
5252
- /codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period

content/codespaces/managing-codespaces-for-your-organization/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ children:
1313
- /choosing-who-owns-and-pays-for-codespaces-in-your-organization
1414
- /listing-the-codespaces-in-your-organization
1515
- /managing-the-cost-of-github-codespaces-in-your-organization
16-
- /managing-secrets-for-your-repository-and-organization-for-github-codespaces
16+
- /managing-development-environment-secrets-for-your-repository-or-organization
1717
- /managing-repository-access-for-your-organizations-codespaces
1818
- /reviewing-your-organizations-audit-logs-for-github-codespaces
1919
- /restricting-access-to-machine-types
@@ -24,4 +24,3 @@ children:
2424
- /restricting-the-retention-period-for-codespaces
2525
product: '{% data reusables.gated-features.codespaces-org %}'
2626
---
27-

content/codespaces/managing-codespaces-for-your-organization/managing-secrets-for-your-repository-and-organization-for-github-codespaces.md renamed to content/codespaces/managing-codespaces-for-your-organization/managing-development-environment-secrets-for-your-repository-or-organization.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
2-
title: Managing secrets for your repository and organization for GitHub Codespaces
2+
title: Managing development environment secrets for your repository or organization
33
shortTitle: Manage secrets
4-
intro: 'Secrets allow you to store sensitive information in your organization or repository for use with {% data variables.product.prodname_github_codespaces %}.'
5-
permissions: 'To manage secrets for {% data variables.product.prodname_github_codespaces %} for an organization, you must be an organization owner.'
4+
intro: 'Development environment secrets allow you to store sensitive information in your organization or repository for use with {% data variables.product.prodname_github_codespaces %}.'
5+
permissions: 'To manage development environment secrets for {% data variables.product.prodname_github_codespaces %} for an organization, you must be an organization owner.'
66
versions:
77
fpt: '*'
88
ghec: '*'
@@ -11,18 +11,19 @@ topics:
1111
- Secret store
1212
- Security
1313
redirect_from:
14+
- /codespaces/managing-codespaces-for-your-organization/managing-secrets-for-your-repository-and-organization-for-github-codespaces
1415
- /codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces
1516
- /codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-github-codespaces
16-
product: 'Secrets are available in all public repositories, in private repositories owned by personal accounts, and in private repositories owned by organizations on {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %} plans. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)."'
17+
product: 'Development environment secrets are available in all public repositories, in private repositories owned by personal accounts, and in private repositories owned by organizations on {% data variables.product.prodname_team %} or {% data variables.product.prodname_enterprise %} plans. For more information, see "[AUTOTITLE](/get-started/learning-about-github/githubs-plans)."'
1718
---
1819

1920
## About secrets
2021

21-
Development environment secrets are {% ifversion fpt or ghec %}encrypted {% endif %}environment variables that you create in the {% data variables.product.prodname_github_codespaces %} settings for an organization, a repository, or a personal account. For information on creating user-specific secrets, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces)."
22+
Development environment secrets are {% ifversion fpt or ghec %}encrypted {% endif %}environment variables that you create in the {% data variables.product.prodname_github_codespaces %} settings for an organization, a repository, or a personal account. This article explains how to manage organization secrets and repository secrets. For information on creating user-specific secrets, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)."
2223

23-
The secrets that you create are available to use in {% data variables.product.prodname_github_codespaces %}. {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} uses a [libsodium sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to encrypt secrets before they reach {% data variables.product.prodname_dotcom %} and only decrypts them when you use them in a codespace.
24+
The development environment secrets that you create are available to use in {% data variables.product.prodname_github_codespaces %}. {% ifversion fpt or ghec %}{% data variables.product.prodname_dotcom %} uses a [libsodium sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to encrypt secrets before they reach {% data variables.product.prodname_dotcom %} and only decrypts them when you use them in a codespace.
2425

25-
{% endif %}Organization-level secrets let you share secrets between multiple repositories, which reduces the need to create duplicate secrets. You can use access policies to control which repositories can use organization secrets.
26+
{% endif %}Organization secrets let you share secrets between multiple repositories, which reduces the need to create duplicate secrets. You can use access policies to control which repositories can use organization secrets.
2627

2728
{% data reusables.codespaces.secrets-on-start %}
2829

@@ -87,4 +88,4 @@ You can check which access policies are applied to a development environment sec
8788

8889
## Further reading
8990

90-
- "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces)"
91+
- "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces)"

content/codespaces/managing-your-codespaces/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,8 @@ topics:
99
redirect_from:
1010
- /codespaces/working-with-your-codespace
1111
children:
12-
- /managing-secrets-for-your-codespaces
12+
- /managing-your-account-specific-secrets-for-github-codespaces
1313
- /managing-repository-access-for-your-codespaces
1414
- /reviewing-your-security-logs-for-github-codespaces
1515
- /managing-gpg-verification-for-github-codespaces
1616
---
17-

content/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces.md renamed to content/codespaces/managing-your-codespaces/managing-your-account-specific-secrets-for-github-codespaces.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
2-
title: Managing secrets for your codespaces
2+
title: Managing your account-specific secrets for GitHub Codespaces
33
shortTitle: Codespaces secrets
44
intro: 'You can store sensitive information, like tokens, that you want to access in your codespaces via environment variables.'
55
versions:
66
fpt: '*'
77
ghec: '*'
88
redirect_from:
9+
- /codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces
910
- /github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces
1011
- /codespaces/working-with-your-codespace/managing-encrypted-secrets-for-codespaces
1112
- /codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces
@@ -96,7 +97,7 @@ Development environment secrets cannot be used:
9697

9798
## Further reading
9899

99-
- "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-secrets-for-your-repository-and-organization-for-github-codespaces)"
100+
- "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-development-environment-secrets-for-your-repository-or-organization)"
100101
- "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#recommended-secrets)"
101102
- "[AUTOTITLE](/codespaces/setting-your-user-preferences)"
102103
- "[AUTOTITLE](/codespaces/customizing-your-codespace)"

content/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ You will need to create a new personal account and then use this account to crea
5454
{% endif %}
5555
1. Copy the token string. You will assign this to a {% data variables.product.prodname_codespaces %} repository secret.
5656
1. Sign back into the account that has admin access to the repository.
57-
1. In the repository for which you want to create {% data variables.product.prodname_github_codespaces %} prebuilds, create a new {% data variables.product.prodname_codespaces %} repository secret called `CODESPACES_PREBUILD_TOKEN`, giving it the value of the token you created and copied. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-a-repository)."
57+
1. In the repository for which you want to create {% data variables.product.prodname_github_codespaces %} prebuilds, create a new {% data variables.product.prodname_codespaces %} repository secret called `CODESPACES_PREBUILD_TOKEN`, giving it the value of the token you created and copied. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-development-environment-secrets-for-your-repository-or-organization#adding-secrets-for-a-repository)."
5858

5959
The {% data variables.product.pat_generic %} will be used for all subsequent prebuilds created for your repository. Unlike other {% data variables.product.prodname_codespaces %} repository secrets, the `CODESPACES_PREBUILD_TOKEN` secret is only used for prebuilding and will not be available for use in codespaces created from your repository.
6060

content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ For information about editing and deleting prebuild configurations, see "[AUTOTI
127127

128128
## Configuring environment variables
129129

130-
To allow the prebuild process to access environment variables required to create your development environment, you can set these either as {% data variables.product.prodname_codespaces %} repository secrets or as {% data variables.product.prodname_codespaces %} organization secrets. Secrets that you create in this way will be accessible by anyone who creates a codespace from this repository. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-a-repository)" and "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-secrets-for-your-repository-and-organization-for-github-codespaces#adding-secrets-for-an-organization)."
130+
To allow the prebuild process to access environment variables required to create your development environment, you can set these either as {% data variables.product.prodname_codespaces %} repository secrets or as {% data variables.product.prodname_codespaces %} organization secrets. Secrets that you create in this way will be accessible by anyone who creates a codespace from this repository. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-development-environment-secrets-for-your-repository-or-organization#adding-secrets-for-a-repository)."
131131

132132
Prebuilds cannot use any user-level secrets while building your environment, because these are not available until after the codespace has been created.
133133

0 commit comments

Comments
 (0)