GitHub Codespaces beta features (#17037)
* Add new articles * Rename article * Add secrets content * Remove permissions statements * Fix image name * Fix article name * Mention GPG verification for Codespaces in "About commit signature verification" * Add GPG verification content * Add access and security procedure * Add 💅 * Rename articles * Rename the other article * Rename again * Okay, rename this one again, too * Update link * Start access and security content * Add 💅 * Mention new functionalities in "Personalizing..." * Mention new features in "About Codespaces" * Add 💅 * Fix typos * Add audit log events * Fix so many links * Add 💅 * Add permissions * Spell access correctly, for once * Add 💅 * FIX THESE LINKS I SWEAR * Addd missing ) * Start adding procedure * update with procedural * Update content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> * Update content/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces.md Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> * Apply suggestions from code review Committing all reviews ✨ Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: Matt Pollard <mattpollard@users.noreply.github.com> Co-authored-by: Meg Bird <megbird@github.com>
This commit is contained in:
@@ -38,6 +38,8 @@ Each developer can create one or more codespace for any public repository, or fo
|
||||
|
||||
{% data reusables.codespaces.about-personalization %} For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)."
|
||||
|
||||
You can configure settings to add encrypted secrets, enable GPG verification, and allow codespaces to access other repositories. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)", and "[Managing access and security for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)."
|
||||
|
||||
{% data reusables.codespaces.you-can-see-all-your-codespaces %}
|
||||
|
||||
{% data reusables.codespaces.beta-functionality-limited %}
|
||||
|
||||
@@ -19,6 +19,9 @@ versions:
|
||||
{% link_in_list /creating-a-codespace %}
|
||||
{% link_in_list /developing-in-a-codespace %}
|
||||
{% link_in_list /personalizing-codespaces-for-your-account %}
|
||||
{% link_in_list /managing-encrypted-secrets-for-codespaces %}
|
||||
{% link_in_list /managing-access-and-security-for-codespaces %}
|
||||
{% link_in_list /managing-gpg-verification-for-codespaces %}
|
||||
{% link_in_list /deleting-a-codespace %}
|
||||
{% link_in_list /troubleshooting-your-codespace %}
|
||||
{% link_in_list /using-codespaces-in-visual-studio-code %}
|
||||
|
||||
@@ -0,0 +1,41 @@
|
||||
---
|
||||
title: Managing access and security for Codespaces
|
||||
intro: You can manage the repositories that codespaces can access.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Access and security for {% data variables.product.prodname_codespaces %} is currently in beta and subject to change.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### Managing security and access for your user account
|
||||
|
||||
When you enable access and security for a repository owned by your user account, any codespaces you create for that repository will have read and write permissions to all other repositories you own. You can enable access and security for none of your repositories, all of your repositories, or specific repositories. You should only enable access and security for repositories you trust.
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.codespaces-tab %}
|
||||
1. Under "Access and security", select the setting you want for your user account.
|
||||

|
||||
1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat for all repositories whose codespaces you want to access other repositories you own.
|
||||

|
||||
|
||||
### Managing security and access for your organization
|
||||
|
||||
Organization owners can manage security and access for {% data variables.product.prodname_codespaces %}.
|
||||
|
||||
When you enable access and security for a repository owned by your organization, any codespaces that are created for that repository will have read and write permissions to all other repositories the organization owns. You can enable access and security for none of your organization's repositories, all of your organization's repositories, or specific repositories. You should only enable access and security for repositories you trust.
|
||||
|
||||
{% data reusables.profile.access_profile %}
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.organizations.org_settings %}
|
||||
{% data reusables.organizations.click-codespaces %}
|
||||
5. To approve of the [pre-release program terms of service](/github/site-policy/github-pre-release-program) on behalf of your organization and enable {% data variables.product.prodname_codespaces %}, under "User permissions", select **Selected users**, then type the username for each person to grant access to. Repeat for all users who you want to have access to your organization's codespaces.
|
||||

|
||||
1. Under "Access and security", select the setting you want for your organization.
|
||||

|
||||
1. If you chose "Selected repositories", select the drop-down menu, then click a repository to allow the repository's codespaces to access other repositories owned by your organization. Repeat for all repositories whose codespaces you want to access other repositories.
|
||||

|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Managing encrypted secrets for Codespaces
|
||||
intro: You can store sensitive information, like tokens, that you want to access in your codespaces via environment variables.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Encrypted secrets for {% data variables.product.prodname_codespaces %} is currently in beta and subject to change.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
### About encrypted secrets for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
You can add encrypted secrets to your user account that you want to use in your codespaces. For example, you may want to store and access the following sensitive information as encrypted secrets.
|
||||
|
||||
- Personal access tokens to cloud services
|
||||
- Service principals
|
||||
- Subscription identifiers
|
||||
|
||||
You can choose which repositories should have access to each secret. Then, you can use the secret in any codespace you create for a repository that has access to the secret.
|
||||
|
||||
### Adding a secret
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.codespaces-tab %}
|
||||
1. To the right of "Codespaces secrets", click **New secret**.
|
||||

|
||||
1. Under "Name", type a name for your secret.
|
||||

|
||||
{% data reusables.user_settings.codespaces-secret-value %}
|
||||
{% data reusables.user_settings.codespaces-secret-repository-access %}
|
||||
1. Click **Add secret**.
|
||||
|
||||
### Editing a secret
|
||||
|
||||
You can update the value of an existing secret, and you can change which repositories can access a secret.
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.codespaces-tab %}
|
||||
1. Under "Codespaces secrets", to the right of the secret you want to edit, click **Update**.
|
||||

|
||||
1. Under "Value", click **enter a new value**.
|
||||

|
||||
{% data reusables.user_settings.codespaces-secret-value %}
|
||||
{% data reusables.user_settings.codespaces-secret-repository-access %}
|
||||
1. Optionally, to remove the secret's access to a repository, deselect the repository.
|
||||

|
||||
1. Click **Save changes**.
|
||||
|
||||
### Deleting a secret
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.codespaces-tab %}
|
||||
1. Under "Codespaces secrets", to the right of the secret you want to delete, click **Delete**.
|
||||

|
||||
1. Read the warning, then click **OK**.
|
||||

|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: Managing GPG verification for Codespaces
|
||||
intro: You can allow {% data variables.product.company_short %} to automatically use GPG to sign commits you make in your codespaces, so other people can be confident that the changes come from a trusted source.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** GPG verification for {% data variables.product.prodname_codespaces %} is currently in beta and subject to change.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
After you enable GPG verification, {% data variables.product.company_short %} will automatically sign commits you make in {% data variables.product.prodname_codespaces %}, and the commits will have a verified status on {% data variables.product.product_name %}. By default, GPG verification is disabled for codespaces you create. You can choose to allow GPG verification for all repositories or specific repositories. Only enable GPG verification for repositories that you trust. For more information about {% data variables.product.product_name %}-signed commits, see "[About commit signature verification](/github/authenticating-to-github/about-commit-signature-verification)."
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.codespaces-tab %}
|
||||
1. Under "GPG verification", select the setting you want for GPG verification.
|
||||

|
||||
1. If you chose "Selected repositories", select the drop-down menu, then click a repository you want enable GPG verification for. Repeat for all repositories you want to enable GPG verification for.
|
||||

|
||||
@@ -40,6 +40,7 @@ For more information, see [Personalizing](https://docs.microsoft.com/visualstudi
|
||||
|
||||
{% endnote %}
|
||||
|
||||
You can also configure settings for your user account to add encrypted secrets, enable GPG verification, and allow your codespaces to access other repositories. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)", and "[Managing access and security for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)."
|
||||
|
||||
### Further reading
|
||||
|
||||
|
||||
Reference in New Issue
Block a user