[MERGE 8/11 @ 8:45am PT] Codespaces Megabranch (#20378)
Adding Codespaces docs
BIN
assets/images/help/billing/codespaces-compute-storage.png
Normal file
|
After Width: | Height: | Size: 98 KiB |
BIN
assets/images/help/billing/limit-or-unlimited-codespaces.png
Normal file
|
After Width: | Height: | Size: 57 KiB |
BIN
assets/images/help/codespaces/browser-console-log-save.png
Normal file
|
After Width: | Height: | Size: 332 KiB |
BIN
assets/images/help/codespaces/changes-in-files.png
Normal file
|
After Width: | Height: | Size: 42 KiB |
|
Before Width: | Height: | Size: 47 KiB After Width: | Height: | Size: 61 KiB |
|
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 24 KiB |
|
Before Width: | Height: | Size: 44 KiB After Width: | Height: | Size: 73 KiB |
|
Before Width: | Height: | Size: 20 KiB After Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 33 KiB |
BIN
assets/images/help/codespaces/find-codespace-id.png
Normal file
|
After Width: | Height: | Size: 280 KiB |
BIN
assets/images/help/codespaces/find-codespace-name-github.png
Normal file
|
After Width: | Height: | Size: 184 KiB |
BIN
assets/images/help/codespaces/github-pr-view.png
Normal file
|
After Width: | Height: | Size: 35 KiB |
BIN
assets/images/help/codespaces/incorporating-codespaces.png
Normal file
|
After Width: | Height: | Size: 56 KiB |
BIN
assets/images/help/codespaces/install-dotfiles.png
Normal file
|
After Width: | Height: | Size: 27 KiB |
BIN
assets/images/help/codespaces/launch-default-editor.png
Normal file
|
After Width: | Height: | Size: 59 KiB |
BIN
assets/images/help/codespaces/new-codespace-button.JPG
Normal file
|
After Width: | Height: | Size: 32 KiB |
|
Before Width: | Height: | Size: 9.9 KiB After Width: | Height: | Size: 273 KiB |
BIN
assets/images/help/codespaces/open-with-codespaces-pr.png
Normal file
|
After Width: | Height: | Size: 88 KiB |
|
Before Width: | Height: | Size: 50 KiB After Width: | Height: | Size: 84 KiB |
|
Before Width: | Height: | Size: 15 KiB After Width: | Height: | Size: 10 KiB |
BIN
assets/images/help/codespaces/select-default-editor.png
Normal file
|
After Width: | Height: | Size: 22 KiB |
BIN
assets/images/help/codespaces/select-default-region.png
Normal file
|
After Width: | Height: | Size: 39 KiB |
BIN
assets/images/help/codespaces/start-review.png
Normal file
|
After Width: | Height: | Size: 88 KiB |
BIN
assets/images/help/codespaces/submit-review.png
Normal file
|
After Width: | Height: | Size: 50 KiB |
|
Before Width: | Height: | Size: 28 KiB After Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 71 KiB After Width: | Height: | Size: 19 KiB |
|
Before Width: | Height: | Size: 18 KiB After Width: | Height: | Size: 16 KiB |
@@ -3,7 +3,7 @@ import { preserveAnchorNodePosition } from 'scroll-anchoring'
|
||||
|
||||
import { sendEvent, EventType } from './events'
|
||||
|
||||
const supportedTools = ['cli', 'desktop', 'webui', 'curl']
|
||||
const supportedTools = ['cli', 'desktop', 'webui', 'curl', 'codespaces']
|
||||
|
||||
export default function displayToolSpecificContent() {
|
||||
const toolElements = Array.from(document.querySelectorAll('.extended-markdown')).filter((el) =>
|
||||
|
||||
@@ -12,6 +12,7 @@ enum NotificationType {
|
||||
RELEASE = 'RELEASE',
|
||||
TRANSLATION = 'TRANSLATION',
|
||||
EARLY_ACCESS = 'EARLY_ACCESS',
|
||||
FEATURE = 'FEATURE',
|
||||
}
|
||||
|
||||
type Notif = {
|
||||
@@ -71,6 +72,13 @@ export const HeaderNotifications = () => {
|
||||
})
|
||||
}
|
||||
|
||||
const featureNotices: Array<Notif> = []
|
||||
if (router.asPath.startsWith('/codespaces') && router.locale === 'en') {
|
||||
featureNotices.push({
|
||||
type: NotificationType.FEATURE,
|
||||
content: `🎉 Codespaces is now available for Teams and Enterprise Cloud plans. Read <a href="https://github.co/codespaces-quickstart">how to get started</a>.`,
|
||||
})
|
||||
}
|
||||
const allNotifications: Array<Notif> = [
|
||||
...translationNotices,
|
||||
...releaseNotices,
|
||||
@@ -81,6 +89,7 @@ export const HeaderNotifications = () => {
|
||||
content: t('notices.early_access'),
|
||||
}
|
||||
: null,
|
||||
...featureNotices,
|
||||
].filter(ExcludesNull)
|
||||
|
||||
return (
|
||||
@@ -98,6 +107,7 @@ export const HeaderNotifications = () => {
|
||||
type === NotificationType.TRANSLATION && 'color-bg-info',
|
||||
type === NotificationType.RELEASE && 'color-bg-info',
|
||||
type === NotificationType.EARLY_ACCESS && 'color-bg-danger',
|
||||
type === NotificationType.FEATURE && 'color-bg-info',
|
||||
!isLast && 'border-bottom color-border-tertiary'
|
||||
)}
|
||||
dangerouslySetInnerHTML={{ __html: content }}
|
||||
|
||||
@@ -13,6 +13,7 @@ children:
|
||||
- /managing-your-github-billing-settings
|
||||
- /managing-billing-for-your-github-account
|
||||
- /managing-billing-for-github-actions
|
||||
- /managing-billing-for-github-codespaces
|
||||
- /managing-billing-for-github-packages
|
||||
- /managing-your-license-for-github-enterprise
|
||||
- /managing-billing-for-github-advanced-security
|
||||
|
||||
@@ -46,7 +46,7 @@ Organizations owners and billing managers can manage the spending limit for {% d
|
||||
|
||||
{% data reusables.organizations.billing-settings %}
|
||||
{% data reusables.dotcom_billing.manage-spending-limit %}
|
||||
{% data reusables.dotcom_billing.monthly-spending-limit %}
|
||||
{% data reusables.dotcom_billing.monthly-spending-limit-actions-packages %}
|
||||
{% data reusables.dotcom_billing.update-spending-limit %}
|
||||
|
||||
## Managing the spending limit for {% data variables.product.prodname_actions %} for your enterprise account
|
||||
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
title: About billing for Codespaces
|
||||
shortTitle: About billing
|
||||
intro: 'View pricing and see how to manage {% data variables.product.prodname_codespaces %} billing for your organization.'
|
||||
permissions: 'To manage billing for Codespaces for an organization, you must be an organization owner or a billing manager.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: overview
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
topics:
|
||||
- Codespaces
|
||||
- Billing
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.codespaces-trial-period %}
|
||||
|
||||
## {% data variables.product.prodname_codespaces %} pricing
|
||||
|
||||
{% data variables.product.prodname_codespaces %} usage is billed for all accounts on the Team and Enterprise plans, and does not include any entitlements. Individual accounts are not currently billed for {% data variables.product.prodname_codespaces %} usage.
|
||||
|
||||
{% data variables.product.prodname_codespaces %} usage is billed according to the units of measure in the following table:
|
||||
|
||||
Product | SKU | Unit of measure | Price |
|
||||
| ------------------- | -------- | --------------- | ----- |
|
||||
| Codespaces Compute | 2 core | 1 hour | $0.18 |
|
||||
| | 4 core | 1 hour | $0.36 |
|
||||
| | 8 core | 1 hour | $0.72 |
|
||||
| | 16 core | 1 hour | $1.44 |
|
||||
| | 32 core | 1 hour | $2.88 |
|
||||
| Codespaces Storage | Storage | 1 GB-month | $0.07 |
|
||||
|
||||
## About billing for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
{% data reusables.codespaces.codespaces-billing %}
|
||||
|
||||
Your {% data variables.product.prodname_codespaces %} usage shares your account's existing billing date, payment method, and receipt. {% data reusables.dotcom_billing.view-all-subscriptions %}
|
||||
|
||||
If you purchased {% data variables.product.prodname_enterprise %} through a Microsoft Enterprise Agreement, you can connect your Azure Subscription ID to your enterprise account to enable and pay for {% data variables.product.prodname_codespaces %} usage. For more information, see "[Connecting an Azure subscription to your enterprise](/github/setting-up-and-managing-your-enterprise/connecting-an-azure-subscription-to-your-enterprise)."
|
||||
|
||||
## Setting a spending limit
|
||||
|
||||
{% data reusables.codespaces.codespaces-spending-limit-requirement %}
|
||||
|
||||
For information on managing and changing your account's spending limit, see "[Managing your spending limit for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)."
|
||||
|
||||
## How billing is handled for forked repositories
|
||||
|
||||
{% data variables.product.prodname_codespaces %} can only be used in organizations where a billable owner has been defined. To incur charges to the organization, the user must be a member or collaborator, otherwise they cannot create a codespace.
|
||||
|
||||
For example, a user in a private organization can fork a repository within that organization, and can subsequently use a codespace billed to the organization; this is because the organization is the owner of the parent repository, which can remove the user's access, the forked repository, and the codespace.
|
||||
|
||||
## How billing is handled when a repository is transferred
|
||||
|
||||
Usage is billed and reported on every hour. As such, you pay for any usage when a repository is within your organization. When a repository is transferred out of your organization, any codespaces in that repository are removed as part of the transfer process.
|
||||
|
||||
## What happens when users are removed
|
||||
|
||||
If a user is removed from an organization or repository, their codespaces are automatically deleted.
|
||||
@@ -0,0 +1,13 @@
|
||||
---
|
||||
title: Managing billing for GitHub Codespaces
|
||||
shortTitle: Codespaces
|
||||
intro: 'You can view your usage and set a spending limit for {% data variables.product.prodname_codespaces %}.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
children:
|
||||
- /about-billing-for-codespaces
|
||||
- /viewing-your-codespaces-usage
|
||||
- /managing-spending-limits-for-codespaces
|
||||
---
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
title: Managing spending limits for Codespaces
|
||||
intro: 'You can set a spending limit for {% data variables.product.prodname_codespaces %} usage.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: how_to
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
topics:
|
||||
- Codespaces
|
||||
- Enterprise
|
||||
- Organizations
|
||||
- Spending limits
|
||||
- User account
|
||||
- Billing
|
||||
shortTitle: Spending limits
|
||||
---
|
||||
## About spending limits for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
{% data reusables.codespaces.codespaces-spending-limit-requirement %}
|
||||
|
||||
Once you've reached your spending limit, your organization or repository will no longer be able to create new codespaces, and won't be able to start existing codespaces. Any existing codespaces that are still running will not be shutdown; if you don't change the spending limit, you will not be charged for the amount that exceeds the limit.
|
||||
|
||||
For more information about pricing for {% data variables.product.prodname_codespaces %} usage, see "[About billing for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces)."
|
||||
|
||||
## Using your Azure Subscription
|
||||
If you purchased {% data variables.product.prodname_enterprise %} through a Microsoft Enterprise Agreement, you can connect your Azure Subscription ID to your enterprise account to enable and pay for {% data variables.product.prodname_codespaces %} usage. For more information, see "[Connecting an Azure subscription to your enterprise](/github/setting-up-and-managing-your-enterprise/connecting-an-azure-subscription-to-your-enterprise)."
|
||||
|
||||
## Managing the spending limit for {% data variables.product.prodname_codespaces %} for your organization
|
||||
|
||||
Organizations owners and billing managers can manage the spending limit for {% data variables.product.prodname_codespaces %} for an organization.
|
||||
|
||||
{% data reusables.organizations.billing-settings %}
|
||||
{% data reusables.dotcom_billing.manage-spending-limit %}
|
||||
{% data reusables.dotcom_billing.monthly-spending-limit-codespaces %}
|
||||
{% data reusables.dotcom_billing.update-spending-limit %}
|
||||
|
||||
## Managing the spending limit for {% data variables.product.prodname_codespaces %} for your enterprise account
|
||||
|
||||
Enterprise owners and billing managers can manage the spending limit for {% data variables.product.prodname_codespaces %} for an enterprise account.
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.billing-tab %}
|
||||
1. Above "{% data variables.product.prodname_codespaces %} monthly usage", click **Spending Limit**.
|
||||

|
||||
{% data reusables.dotcom_billing.monthly-spending-limit %}
|
||||
{% data reusables.dotcom_billing.update-spending-limit %}
|
||||
@@ -0,0 +1,29 @@
|
||||
---
|
||||
title: Viewing your Codespaces usage
|
||||
shortTitle: Viewing your usage
|
||||
intro: 'You can view the compute minutes and storage used by {% data variables.product.prodname_codespaces %}.'
|
||||
permissions: 'To manage billing for Codespaces for an organization, you must be an organization owner or a billing manager.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- Codespaces
|
||||
- Billing
|
||||
---
|
||||
|
||||
## Viewing {% data variables.product.prodname_codespaces %} usage for your organization
|
||||
|
||||
Organization owners and billing managers can view {% data variables.product.prodname_codespaces %} usage for an organization. For organizations managed by an enterprise account, the organization owners can view {% data variables.product.prodname_codespaces %} usage in the organization billing page, and enterprise admins can view the usage for the entire enterprise.
|
||||
|
||||
{% data reusables.organizations.billing-settings %}
|
||||
{% data reusables.dotcom_billing.codespaces-minutes %}
|
||||
|
||||
## Viewing {% data variables.product.prodname_codespaces %} usage for your enterprise account
|
||||
|
||||
Enterprise owners and billing managers can view {% data variables.product.prodname_codespaces %} usage for an enterprise account.
|
||||
|
||||
{% data reusables.enterprise-accounts.access-enterprise %}
|
||||
{% data reusables.enterprise-accounts.settings-tab %}
|
||||
{% data reusables.enterprise-accounts.billing-tab %}
|
||||
1. Under "{% data variables.product.prodname_codespaces %}", view the usage details of each organization in your enterprise account.
|
||||
@@ -46,7 +46,7 @@ Organizations owners and billing managers can manage the spending limit for {% d
|
||||
|
||||
{% data reusables.organizations.billing-settings %}
|
||||
{% data reusables.dotcom_billing.manage-spending-limit %}
|
||||
{% data reusables.dotcom_billing.monthly-spending-limit %}
|
||||
{% data reusables.dotcom_billing.monthly-spending-limit-actions-packages %}
|
||||
{% data reusables.dotcom_billing.update-spending-limit %}
|
||||
|
||||
## Managing the spending limit for {% data variables.product.prodname_registry %} for your enterprise account
|
||||
|
||||
@@ -1,19 +0,0 @@
|
||||
---
|
||||
title: About billing for Codespaces
|
||||
intro: 'When {% data variables.product.prodname_codespaces %} becomes generally available, you will be billed for storage and compute usage.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
redirect_from:
|
||||
- /github/developing-online-with-codespaces/about-billing-for-codespaces
|
||||
- /codespaces/getting-started-with-codespaces/about-billing-for-codespaces
|
||||
type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Billing
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
{% data reusables.codespaces.about-billing-for-codespaces %}
|
||||
|
||||
Updates on the billing model for Codespaces will be shared in an upcoming announcement.
|
||||
@@ -1,68 +0,0 @@
|
||||
---
|
||||
title: About Codespaces
|
||||
intro: '{% data variables.product.prodname_codespaces %} is a configurable online development environment, hosted by {% data variables.product.prodname_dotcom %} and powered by {% data variables.product.prodname_vscode %}, that allows you to develop entirely in the cloud.'
|
||||
redirect_from:
|
||||
- /github/developing-online-with-github-codespaces/about-github-codespaces
|
||||
- /github/developing-online-with-codespaces/about-codespaces
|
||||
- /codespaces/getting-started-with-codespaces/about-codespaces
|
||||
- /codespaces/about-codespaces
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: overview
|
||||
topics:
|
||||
- Codespaces
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
## About {% data variables.product.prodname_codespaces %}
|
||||
|
||||
{% data variables.product.prodname_codespaces %} is a configurable cloud development environment available in your browser on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}.
|
||||
|
||||

|
||||
|
||||
A codespace includes everything developers need to develop for a specific repository, including the {% data variables.product.prodname_vscode %} editing experience and common languages, tools, and utilities. {% data variables.product.prodname_codespaces %} is completely configurable, allowing you to create a customized development environment for your project, and allowing developers to personalize their experience with extensions and dotfile settings.
|
||||
|
||||
Codespaces offers many benefits to teams by allowing for a consistent environment across your entire team, fast onboarding, and creating a secure space for development.
|
||||
|
||||
## A consistent environment
|
||||
|
||||
You can create a single codespace configuration that defines the environment (or _dev container_) of every new codespace that anyone creates for your repository. Once you've made a configuration, developers don’t have to worry about installing the right tools to comment, review, or contribute. A standardized environment is already available for them as soon as they create a codespace from the repository. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)."
|
||||
|
||||
For help getting started with configurations for specific languages, see the [Getting Started](/codespaces/getting-started-with-codespaces) tutorials.
|
||||
|
||||
While every codespace created from your repository has a consistent development environment, developers can use {% data variables.product.prodname_codespaces %} wherever they need it – on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}.
|
||||
|
||||
## Fast and personal onboarding
|
||||
|
||||
With a [dev container](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#about-dev-containers) configured in your repository, any new developer can quickly onboard with the correct development environment for your project by using the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and selecting **Open with Codespaces**.
|
||||
|
||||

|
||||
|
||||
As a result of standardizing on a repeatable developer environment, developers can get started with a new codespace without doing any manual configuration and do not need to do continued maintenance of their developer environment. A new codespace can be created when starting a new feature.
|
||||
|
||||
Developers can also personalize aspects of their codespace environment by using a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync). Personalization can include shell preferences, additional tools, editor settings, and extensions, such as Live Share. Personal customizations are stored on a per-user basis, so every codespace a developer opens has their environment ready to go. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)."
|
||||
|
||||
Because {% data variables.product.prodname_codespaces %} can be accessed in the browser, developers can work on multiple projects by switching between tabs.
|
||||
|
||||
## A secure environment
|
||||
|
||||
{% data variables.product.prodname_codespaces %} allows developers to develop in the cloud instead of locally. This creates one single, trackable, source of truth. Developers can contribute from anywhere, on any machine, including tablets or Chromebooks, and there is no need to maintain local copies of intellectual property. Developers always have to be logged in and provided with access to both {% data variables.product.prodname_codespaces %} and specific repositories. These permissions can be revoked at any time. As soon as you revoke access, those developers will lose all access to protected resources. In addition, authenticated developers create audit trails so you know who is doing what. For more information on access and security, see "[Managing access and security for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)."
|
||||
|
||||
Using {% data variables.product.prodname_codespaces %} is the most secure when all members of your team are using it. It means that there is no need to clone the repository onto a local machine and that developers don't need to install locally as `root`.
|
||||
|
||||
Developers and organization administrators can also configure settings to add encrypted secrets and enable GPG verification. 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)".
|
||||
|
||||
## About billing for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
{% data reusables.codespaces.about-billing-for-codespaces %} For more information, see "[About billing for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-billing-for-codespaces)."
|
||||
|
||||
## Joining the beta
|
||||
|
||||
A limited number of people will be invited to join the beta. To join the waitlist, see [Sign up for the Codespaces beta](https://github.com/features/codespaces/signup).
|
||||
|
||||
## Contacting us about {% data variables.product.prodname_codespaces %}
|
||||
|
||||
If you encounter problems using {% data variables.product.prodname_codespaces %}, see "[Troubleshooting your codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)."
|
||||
|
||||
If you still need help or have feedback about {% data variables.product.prodname_codespaces %}, use the [Codespaces Feedback](https://github.com/github/feedback/discussions/categories/codespaces-feedback) discussion.
|
||||
@@ -5,11 +5,9 @@ versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- Codespaces
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
shortTitle: Private image registry
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
A registry is a secure space for storing and managing private container images, such as Azure Container Registry or DockerHub. You can create secrets in GitHub to store the access details for a private registry and use them to give your codespace access to images stored in the registry.
|
||||
|
||||
When you launch a codespace, {% data variables.product.prodname_codespaces %} checks for three secrets, which define the server name, username, and personal access token (PAT) for a container registry. If these secrets are found, {% data variables.product.prodname_codespaces %} will make the registry available inside your codespace.
|
||||
|
||||
@@ -3,8 +3,10 @@ title: Disaster recovery for Codespaces
|
||||
intro: 'This article describes guidance for a disaster recovery scenario, when a whole region experiences an outage due to major natural disaster or widespread service interruption.'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Disaster recovery
|
||||
---
|
||||
|
||||
We work hard to make sure that {% data variables.product.prodname_codespaces %} is always available to you. However, forces beyond our control sometimes impact the service in ways that can cause unplanned service disruptions.
|
||||
@@ -21,19 +23,7 @@ The following guidance provides options on how to handle service disruption to t
|
||||
|
||||
## Option 1: Create a new codespace in another region
|
||||
|
||||
In the case of a regional outage, we suggest you recreate your codespace in an unaffected region to continue working. This new codespace will have all of the changes as of your last push to {% data variables.product.prodname_dotcom %}.
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.codespaces-tab %}
|
||||
|
||||
1. Under "Region", select the "Set manually" option and choose an unaffected region in the dropdown.
|
||||

|
||||
|
||||
2. Navigate back to your project's repository, use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu and select **Open with Codespaces**.
|
||||

|
||||
|
||||
3. Click {% octicon "plus" aria-label="The plus icon" %} **New codespace** to create a new codespace in the specified region and continue working.
|
||||

|
||||
In the case of a regional outage, we suggest you recreate your codespace in an unaffected region to continue working. This new codespace will have all of the changes as of your last push to {% data variables.product.prodname_dotcom %}. For information on manaully setting another region, see "[Setting your default region for Codespaces](/codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces)."
|
||||
|
||||
You can optimize recovery time by configuring a `devcontainer.json` in the project's repository, which allows you to define the tools, runtimes, frameworks, editor settings, extensions, and other configuration necessary to restore the development environment automatically. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project)."
|
||||
|
||||
@@ -41,7 +31,7 @@ You can optimize recovery time by configuring a `devcontainer.json` in the proje
|
||||
|
||||
In this case, no action on your part is required. Know that we are working diligently to restore service availability.
|
||||
|
||||
Check our [{% data variables.product.prodname_discussions %} page](https://github.com/github/feedback/discussions/categories/codespaces-feedback) for any updates on service interruptions. Soon, you'll be able to see the current service status on the [Status Dashboard](https://www.githubstatus.com/).
|
||||
You can check the current service status on the [Status Dashboard](https://www.githubstatus.com/).
|
||||
|
||||
## Option 3: Clone the repository locally or edit in the browser
|
||||
|
||||
|
||||
@@ -3,12 +3,11 @@ title: Reference
|
||||
intro: 'This section contains references that will allow you to be successful with {% data variables.product.prodname_codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
children:
|
||||
- /about-codespaces
|
||||
- /about-billing-for-codespaces
|
||||
- /troubleshooting-your-codespace
|
||||
- /understanding-billing-for-codespaces
|
||||
- /allowing-your-codespace-to-access-a-private-image-registry
|
||||
- /using-the-command-palette-in-codespaces
|
||||
- /security-in-codespaces
|
||||
- /disaster-recovery-for-codespaces
|
||||
---
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
@@ -0,0 +1,105 @@
|
||||
---
|
||||
title: Security in Codespaces
|
||||
intro: 'Overview of the {% data variables.product.prodname_codespaces %} security architecture, with guidelines to help you maintain security and minimize the risk of attack.'
|
||||
miniTocMaxHeadingLevel: 3
|
||||
versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- Codespaces
|
||||
- Security
|
||||
type: reference
|
||||
shortTitle: Security in Codespaces
|
||||
---
|
||||
|
||||
## Overview of codespace security
|
||||
|
||||
{% data variables.product.prodname_codespaces %} is designed to be security hardened by default. Consequently, you will need to ensure that your software development practices do not risk reducing the security posture of your codespace.
|
||||
|
||||
This guide describes the way Codespaces keeps your development environment secure and provides some of the good practices that will help maintain your security as you work. As with any development tool, remember that you should only open and work within repositories you know and trust.
|
||||
|
||||
### Environment isolation
|
||||
|
||||
{% data variables.product.prodname_codespaces %} is designed to keep your codespaces separate from each other, with each using its own virtual machine and network.
|
||||
|
||||
#### Isolated virtual machines
|
||||
|
||||
Each codespace is hosted on its own newly-built virtual machine (VM). Two codespaces are never co-located on the same VM.
|
||||
|
||||
Every time you restart a codespace, it's deployed to a new VM with the latest available security updates.
|
||||
|
||||
#### Isolated networking
|
||||
|
||||
Each codespace has its own isolated virtual network. We use firewalls to block incoming connections from the internet and to prevent codespaces from communicating with each other on internal networks. By default, codespaces are allowed to make outbound connections to the internet.
|
||||
|
||||
### Authentication
|
||||
|
||||
You can connect to a codespace using a web browser or from Visual Studio Code. If you connect from Visual Studio Code, you are prompted to authenticate with {% data variables.product.product_name %}.
|
||||
|
||||
Every time a codespace is created or restarted, it's assigned a new {% data variables.product.company_short %} token with an automatic expiry period. This period allows you to work in the codespace without needing to reauthenticate during a typical working day, but reduces the chance that you will leave a connection open when you stop using the codespace.
|
||||
|
||||
The token's scope will vary depending on the access you have to the repository where the codespace was created:
|
||||
|
||||
- **If you have write access to the repository**: The token will be scoped for read/write access to the repository.
|
||||
- **If you only have read access to the repository**: The token will only allow the code to be cloned from the source repository. If you attempt to push to a private repo where you only have read access, {% data variables.product.prodname_codespaces %} will prompt you to create a personal fork of the repository. The token will then be updated to have read/write access to the new personal fork.
|
||||
- **If you've enabled your codespace to access other repositories**: When a codespace has been granted [access to other repositories](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces), any codespace created from that repository will have read/write tokens scoped to the source repository. In addition, the tokens will also receive read access to other repositories indicated by the user or organization.
|
||||
|
||||
An organization's administrators specify which repositories should be considered trusted. An admin can [choose to trust](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces) none, all, or some of the organization's repositories. A codespace can't have greater permissions to access resources than the person who created it, even if the organization administrator has granted access to all users and all repositories.
|
||||
|
||||
### Codespace connections
|
||||
|
||||
You can connect to your codespace using the TLS encrypted tunnel provided by the {% data variables.product.prodname_codespaces %} service. Only the creator of a codespace can connect to a codespace. Connections are authenticated with {% data variables.product.product_name %}.
|
||||
|
||||
If you need to allow external access to services running on a codespace, you can enable port forwarding for private or public access.
|
||||
|
||||
### Port forwarding
|
||||
|
||||
If you need to connect to a service (such as a development web server) running within your codespace, you can configure port forwarding to make the service available on the internet.
|
||||
|
||||
**Privately forwarded ports**: Are accessible on the internet, but only the codespace creator can access them, after authenticating to {% data variables.product.product_name %}.
|
||||
|
||||
**Publicly forwarded ports**: Are accessible on the internet, and anyone on the internet can access them. No authentication is needed to access public forwarded ports.
|
||||
|
||||
All forwarded ports are private by default, which means that you will need to authenticate before you can access the port. Access to a codespace's private forwarded ports is controlled by authentication cookies with a 3-hour expiry period. When the cookie expires, you will need to reauthenticate.
|
||||
|
||||
A public forwarded port will automatically revert back to private when you remove and re-add the port, or if you restart the codespace.
|
||||
|
||||
You can use the "Ports" panel to configure a port for public or private access, and can stop port forwarding when it's no longer required. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)."
|
||||
|
||||
## Good security practices for your codespaces
|
||||
|
||||
Codespaces are designed to be security hardened by default. To help maintain this posture, we recommend that you follow good security practices during your development procedures:
|
||||
|
||||
- As with any development tool, remember that you should only open and work within repositories you know and trust.
|
||||
- Before you add new dependencies to the codespace, check whether they are well-maintained, and if they release updates to fix any security vulnerabilities found in their code.
|
||||
|
||||
### Using secrets to access sensitive information
|
||||
|
||||
Always use encrypted secrets when you want to use sensitive information (such as access tokens) in a codespace. You can access your secrets as environment variables in the codespace, including from the terminal. For example, you can launch a terminal within your codespace and use `echo $SECRET_NAME ` to see the value of a secret.
|
||||
|
||||
The secret values are copied to environment variables whenever the codespace is resumed or created, so if you update a secret value while the codespace is running, you’ll need to suspend and resume to pick up the updated value.
|
||||
|
||||
For more information on secrets, see:
|
||||
- "[Managing encrypted secrets for your codespaces](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces)"
|
||||
- "[Managing encrypted secrets for your repository and organization for Codespaces](/codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces)"
|
||||
|
||||
### Working with other people's contributions and repositories
|
||||
|
||||
When you create a codespace from a PR branch from a fork, the token in the codespace will vary depending on whether the repository is public or private:
|
||||
- For a private repository, the codespace is granted access to both the fork and parent.
|
||||
- For a public repository, the codespace will only have access to the fork and opening PRs on the parent.
|
||||
|
||||
### Additional good practices
|
||||
|
||||
There are some additional good practices and risks that you should be aware of when using {% data variables.product.prodname_codespaces %}.
|
||||
|
||||
### Understanding a repository's devcontainer.json file
|
||||
|
||||
When creating a codespace, the [devcontainer.json](https://code.visualstudio.com/docs/remote/devcontainerjson-reference) is parsed and applied from the source repo, if one exists. The devcontainer contains powerful features, such as installing third-party extensions and running arbitrary code through a supplied `postCreateCommand`.
|
||||
|
||||
#### Granting access through features
|
||||
|
||||
Certain development features can potentially add risk to your environment. For example, commit signing, secrets injected into environment variables, authenticated registry access, and packages access can all present potential security issues. We recommend that you only grant access to those who need it and adopt a policy of being as restrictive as possible.
|
||||
|
||||
#### Using extensions
|
||||
|
||||
Any additional {% data variables.product.prodname_vscode %} extensions that you've installed can potentially introduce more risk. To help mitigate this risk, ensure that the you only install trusted extensions, and that they are always kept up to date.
|
||||
@@ -1,69 +0,0 @@
|
||||
---
|
||||
title: Troubleshooting your codespace
|
||||
intro: Use this guide to help you troubleshoot common issues with your codespace.
|
||||
redirect_from:
|
||||
- /github/developing-online-with-github-codespaces/troubleshooting-your-codespace
|
||||
- /github/developing-online-with-codespaces/troubleshooting-your-codespace
|
||||
- /codespaces/working-with-your-codespace/troubleshooting-your-codespace
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Troubleshoot a codespace
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
## Known Limitations
|
||||
|
||||
{% data reusables.codespaces.beta-functionality-limited %}
|
||||
|
||||
{% data reusables.codespaces.unsupported-repos %}
|
||||
|
||||
## {% data variables.product.prodname_vscode %} troubleshooting
|
||||
|
||||
Use **Issues** in the [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) repository to check for known issues or to log issues about the {% data variables.product.prodname_vscode %} experience.
|
||||
|
||||
|
||||
## Configuration troubleshooting
|
||||
|
||||
{% data reusables.codespaces.recovery-mode %}
|
||||
|
||||
```
|
||||
This codespace is currently running in recovery mode due to a container error.
|
||||
```
|
||||
|
||||
Review the creation logs, update the configuration as needed, and run **Codespaces: Rebuild Container** in the command palette to retry. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)."
|
||||
|
||||
## dotfiles troubleshooting
|
||||
|
||||
- Make sure your dotfiles repository is public. If you have secrets or sensitive data you want to use in your codespace, use [Codespace secrets](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) instead of private dotfiles.
|
||||
- Check `/workspaces/.codespaces/.persistedshare/dotfiles` to see if your dotfiles were cloned.
|
||||
- If your dotfiles were cloned, try manually re-running your install script to verify it's executable.
|
||||
- If your dotfiles weren't cloned, check `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` to see if there was a problem cloning them.
|
||||
- Check `/workspaces/.codespaces/.persistedshare/creation.log` for possible issues. Alternatively, you can view the `creation.log` by navigating to the command palette and entering **Codespaces: View Creation Log**.
|
||||
|
||||
|
||||
## Browser troubleshooting
|
||||
|
||||
If you encounter issues while using a browser that is not Chromium-based, try switching to a Chromium-based browser, or check for known issues with your browser in the `microsoft/vscode` repository by searching for issues labeled with the name of your browser, such as[`firefox`](https://github.com/microsoft/vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afirefox) or [`safari`](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Asafari).
|
||||
|
||||
If you encounter issues while using a Chromium-based browser, you can check if you're experiencing another known issue with {% data variables.product.prodname_vscode %} in the [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) repository.
|
||||
|
||||
## Container storage troubleshooting
|
||||
|
||||
When you create a codespace, it has a finite amount of storage and over time it may be necessary for you to free up space. Try any of the following items to free up storage space.
|
||||
|
||||
- Remove packages that are no longer by using `sudo apt autoremove`
|
||||
- Clean the apt cache by using `sudo apt clean`
|
||||
- Delete unneeded files like build artifacts and logs (these are very project-dependent)
|
||||
- See the top 10 largest files in the codespace: `sudo find / -printf '%s %p\n'| sort -nr | head -10`
|
||||
|
||||
More destructive options:
|
||||
- Remove unused Docker images, networks, and containers by using `docker system prune` (append `-a` if you want to remove all images, and `--volumes` if you want to remove all volumes)
|
||||
- Remove untracked files from working tree: `git clean -i`
|
||||
|
||||
## Contact us
|
||||
|
||||
If you still need help, you can contact us. For more information, see "[About {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-codespaces#contacting-us-about-codespaces)."
|
||||
@@ -0,0 +1,53 @@
|
||||
---
|
||||
title: Understanding billing for Codespaces
|
||||
intro: 'Learn how your {% data variables.product.prodname_codespaces %} usage is billed.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
redirect_from:
|
||||
- /github/developing-online-with-codespaces/about-billing-for-codespaces
|
||||
- /codespaces/getting-started-with-codespaces/about-billing-for-codespaces
|
||||
- /codespaces/codespaces-reference/about-billing-for-codespaces
|
||||
type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
- Billing
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
shortTitle: Understanding billing
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.codespaces-trial-period %}
|
||||
|
||||
This article explains how billing works for your codespaces, and explains how your organization's billing manager can help.
|
||||
|
||||
## Getting access to {% data variables.product.prodname_codespaces %}
|
||||
|
||||
Your organization's administrator might limit {% data variables.product.prodname_codespaces %} usage to only specific user accounts. To get access, you will need to contact your billing manager. For more information, see "[Managing access and security for your codespaces](/codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces)."
|
||||
|
||||
## How spending limits work
|
||||
|
||||
Before your organization can use {% data variables.product.prodname_codespaces %}, your billing manager will need to set a spending limit. For more information, see "[Managing billing for Codespaces in your organization](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)."
|
||||
|
||||
## How your codespace usage is billed
|
||||
|
||||
Your codespace is billed for its compute minutes and for the amount of storage it uses on disk.
|
||||
|
||||
### Understanding what compute minutes are
|
||||
Your codespace is billed for the number of minutes that it's active. If your codespaces window is left idle for 30 minutes, it will automatically shutdown, and compute billing for the codespace will end until you start the codespace again.
|
||||
|
||||
### Understanding how codespace storage is billed
|
||||
For {% data variables.product.prodname_codespaces %}, storage is defined to include any files relating to your codespace, such as the cloned repository, configuration files, and extensions, among others. This storage is billed while your codespace is shutdown. The storage billing for a codespace ends when you manually delete it from https://github.com/codespaces.
|
||||
|
||||
## How much it costs to use {% data variables.product.prodname_codespaces %}
|
||||
|
||||
To see the pricing for {% data variables.product.prodname_codespaces %} usage, see "[{% data variables.product.prodname_codespaces %} pricing](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces#codespaces-pricing)."
|
||||
|
||||
## Checking your current usage and limits
|
||||
If you need to check your current usage or spending limit, contact your organization's billing manager. For more information, see "[Viewing your Codespaces usage](/billing/managing-billing-for-github-codespaces/viewing-your-codespaces-usage)."
|
||||
|
||||
## Codespaces can be automatically deleted
|
||||
|
||||
Your codespace will be automatically deleted when you are removed from an organization or repository.
|
||||
|
||||
## Deleting your unused codespaces
|
||||
|
||||
You can manually delete your codespaces in https://github.com/codespaces and from within {% data variables.product.prodname_vscode %}. To reduce the size of a codespace, you can manually delete files using the terminal or from within {% data variables.product.prodname_vscode %}.
|
||||
@@ -7,11 +7,10 @@ type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
- Visual Studio Code
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
shortTitle: Command Palette
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
## About the Command Palette
|
||||
|
||||
The Command Palette is one of the focal features of {% data variables.product.prodname_vscode %} and is available for you to use in Codespaces. The Command Palette allows you to access many commands for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information on using the Command Palette, see "[User Interface](https://code.visualstudio.com/docs/getstarted/userinterface#_command-palette)" in the Visual Studio Code documentation.
|
||||
@@ -36,7 +35,7 @@ To see all commands related to {% data variables.product.prodname_github_codespa
|
||||
|
||||
### Suspending or stopping a codespace
|
||||
|
||||
If you add a new secret, you'll have to stop and restart the codespace for it to apply your changes.
|
||||
If you add a new secret or change the machine type, you'll have to stop and restart the codespace for it to apply your changes.
|
||||
|
||||
To suspend or stop your codespace's container, access the Command Palette, then start typing "stop". Select **Codespaces: Stop Current Codespace**.
|
||||
|
||||
|
||||
@@ -13,10 +13,11 @@ topics:
|
||||
- Codespaces
|
||||
- Set up
|
||||
- Fundamentals
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
shortTitle: Configure your project
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
## About dev containers
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Customizing your codespace
|
||||
intro: '{% data variables.product.prodname_codespaces %} is a dedicated environment for you. You can configure your repositories with a dev container to define their default Codespaces environment, and personalize your development experience across all of your codespaces with dotfiles and Settings Sync.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
redirect_from:
|
||||
@@ -10,5 +11,6 @@ topics:
|
||||
children:
|
||||
- /configuring-codespaces-for-your-project
|
||||
- /personalizing-codespaces-for-your-account
|
||||
- /prebuilding-codespaces-for-your-project
|
||||
---
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
title: Personalizing Codespaces for your account
|
||||
intro: 'You can personalize {% data variables.product.prodname_codespaces %} by using a `dotfiles` repository on {% data variables.product.product_name %} or by using Settings Sync.'
|
||||
permissions: 'Anyone can personalize {% data variables.product.prodname_codespaces %} for their user account.'
|
||||
redirect_from:
|
||||
- /github/developing-online-with-github-codespaces/personalizing-github-codespaces-for-your-account
|
||||
- /github/developing-online-with-codespaces/personalizing-codespaces-for-your-account
|
||||
@@ -13,10 +12,10 @@ topics:
|
||||
- Codespaces
|
||||
- Set up
|
||||
- Fundamentals
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
shortTitle: Personalize your account
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
## About personalizing {% data variables.product.prodname_codespaces %}
|
||||
|
||||
@@ -33,7 +32,7 @@ Project maintainers can also define a default configuration that applies to ever
|
||||
|
||||
Settings Sync allows you to share configurations such as settings, keyboard shortcuts, snippets, extensions, and UI state across machines and instances of {% data variables.product.prodname_vscode %}.
|
||||
|
||||
Settings Sync is on by default. To configure any settings, in the bottom-left corner of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Settings Sync is on**. From the dialog, you can choose to configure, show settings and data, or turn off Settings Sync.
|
||||
To enable Settings Sync, in the bottom-left corner of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Turn on Settings Sync…**. From the dialog, select which settings you'd like to sync.
|
||||
|
||||

|
||||
|
||||
@@ -68,7 +67,32 @@ Any changes to your `dotfiles` repository will apply only to each new codespace,
|
||||
|
||||
{% 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)."
|
||||
### Enabling your dotfiles repository for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
You can use your public `dotfiles` repository to personalize your {% data variables.product.prodname_codespaces %} environment. Once you set up that repository, you can add your scripts, preferences, and configurations to it. You then need to enable your dotfiles from your personal {% data variables.product.prodname_codespaces %} settings page.
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.codespaces-tab %}
|
||||
1. Under "Dotfiles", select "Automatically install dotfiles" so that {% data variables.product.prodname_codespaces %} automatically installs your dotfiles into every new codespace you create.
|
||||

|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** This option is only available if you've created a public `dotfiles` repository for your user account.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
You can add further script, preferences, configuration files to your dotfiles repository or edit existing files whenever you want. Changes to settings will only be picked up by new codespaces.
|
||||
|
||||
## Other available settings
|
||||
|
||||
You can also personalize {% data variables.product.prodname_codespaces %} using additional [Codespaces settings](https://github.com/settings/codespaces):
|
||||
|
||||
- To set your default region, see "[Setting your default region for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces)."
|
||||
- To set your editor, see "[Setting your default editor for {% data variables.product.prodname_codespaces %}](/codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces)."
|
||||
- To add encrypted secrets, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)."
|
||||
- To enable GPG verification, see "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)."
|
||||
- To allow your codespaces to access other repositories, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)."
|
||||
|
||||
## Further reading
|
||||
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: Prebuilding Codespaces for your project
|
||||
intro: 'You can configure your project to prebuild a codespace automatically each time you push a change to your repository.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Codespaces
|
||||
- Set up
|
||||
- Fundamentals
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
shortTitle: Prebuilding Codespaces
|
||||
---
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** This feature is currently in private preview.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
## About prebuilding a Codespace
|
||||
|
||||
Prebuilding your codespaces allows you to be more productive and access your codespace faster. This is because any source code, editor extensions, project dependencies, commands, or configurations have already been downloaded, installed, and applied before you begin your coding session. Once you push changes to your repository, {% data variables.product.prodname_codespaces %} automatically handles configuring the builds.
|
||||
|
||||
The ability to prebuild Codespaces is currently in private preview. To get access to this feature, contact codespaces@github.com.
|
||||
@@ -0,0 +1,60 @@
|
||||
---
|
||||
title: Changing the machine type for your codespace
|
||||
shortTitle: Changing the machine type
|
||||
intro: You can change the type of machine that's running your codespace, so that you're using resources appropriate for work you're doing.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
topics:
|
||||
- Codespaces
|
||||
---
|
||||
|
||||
## About machine types
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** You can only select or change the machine type if you are a member of an organization using {% data variables.product.prodname_codespaces %} and are creating a codespace on a repository owned by that organization.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
{% data reusables.codespaces.codespaces-machine-types %}
|
||||
|
||||
You can choose a machine type either when you create a codespace or you can change the machine type at any time after you've created a codespace.
|
||||
|
||||
For information on choosing a machine type when you create a codespace, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)."
|
||||
For information on changing the machine type within {% data variables.product.prodname_vscode %}, see "[Using {% data variables.product.prodname_codespaces %} in {% data variables.product.prodname_vscode %}](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#changing-the-machine-type-in-visual-studio-code)."
|
||||
|
||||
## Changing the machine type in {% data variables.product.prodname_dotcom %}
|
||||
|
||||
{% data reusables.codespaces.your-codespaces-procedure-step %}
|
||||
|
||||
The current machine type for each of your codespaces is displayed.
|
||||
|
||||

|
||||
|
||||
1. Click the ellipsis (**...**) to the right of the codespace you want to modify.
|
||||
1. Click **Change machine type**.
|
||||
|
||||

|
||||
|
||||
1. Choose the required machine type.
|
||||
|
||||
2. Click **Update codespace**.
|
||||
|
||||
The change will take effect the next time your codespace restarts.
|
||||
|
||||
## Force an immediate update of a currently running codespace
|
||||
|
||||
If you change the machine type of a codespace you are currently using, and you want to apply the changes immediately, you can force the codespace to restart.
|
||||
|
||||
1. At the bottom left of your codespace window, click **{% data variables.product.prodname_codespaces %}**.
|
||||
|
||||

|
||||
|
||||
1. From the options that are displayed at the top of the page select **Codespaces: Stop Current Codespace**.
|
||||
|
||||

|
||||
|
||||
1. After the codespace is stopped, click **Restart codespace**.
|
||||
|
||||

|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: Creating a codespace
|
||||
intro: You can create a codespace for a branch in a repository to develop online.
|
||||
permissions: 'Anyone can create a codespace for any public repository, or for any repository owned by their user account.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
permissions: '{% data reusables.codespaces.availability %}'
|
||||
redirect_from:
|
||||
- /github/developing-online-with-github-codespaces/creating-a-codespace
|
||||
- /github/developing-online-with-codespaces/creating-a-codespace
|
||||
@@ -14,8 +15,6 @@ topics:
|
||||
- Developer
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
## About codespace creation
|
||||
|
||||
You can create a codespace on either {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.codespaces-are-personal %}
|
||||
@@ -23,25 +22,43 @@ You can create a codespace on either {% data variables.product.prodname_dotcom_t
|
||||
Codespaces are associated with a specific branch of a repository and the repository cannot be empty. {% data reusables.codespaces.concurrent-codespace-limit %} For more information, see "[Deleting a codespace](/github/developing-online-with-codespaces/deleting-a-codespace)."
|
||||
|
||||
|
||||
When you create a codespace, a number of steps happen to enable full access to your development environment.
|
||||
When you create a codespace, a number of steps happen to create and connect you to your development environment:
|
||||
|
||||
- Resources such as a VM and storage for your container are assigned. A new VM is created every time you create or start a codespace to ensure that you always have the latest versions and security patches.
|
||||
- {% data variables.product.prodname_codespaces %} receives information about your repository, branch, commits, your public dotfiles repository, and any secrets that you have created.
|
||||
- {% data variables.product.prodname_codespaces %} executes a shallow clone of the repository.
|
||||
- If you have one in your repository, {% data variables.product.prodname_codespaces %} runs the `devcontainer.json` file. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)."
|
||||
- Your Docker container, `docker-compose`, or other initialization is run.
|
||||
- At this point, the codespace is marked as available and you can connect.
|
||||
- Once the codespace is made available, depending on the commands in the devcontainer, the codespace will continue with some set up.
|
||||
- The codespace shares ports added in the `devcontainer.json` file.
|
||||
- The codespace runs anything specified in `postCreateCommand`.
|
||||
- {% data variables.product.prodname_codespaces %} clones your dotfiles repository to the codespaces environment and looks for an install file. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)."
|
||||
- Finally, the codespace does a full clone of the repo so you have full access to it.
|
||||
- Step 1: VM and storage are assigned to your codespace.
|
||||
- Step 2: Container is created and your repository is cloned.
|
||||
- Step 3: You can connect to the codespace.
|
||||
- Step 4: Codespace continues with post-creation setup.
|
||||
|
||||
For more information on what happens when you create a codespace, see "[Deep Dive](/codespaces/getting-started/deep-dive)."
|
||||
|
||||
{% data reusables.codespaces.use-visual-studio-features %}
|
||||
|
||||
{% data reusables.codespaces.you-can-see-all-your-codespaces %}
|
||||
|
||||
## Access to {% data variables.product.prodname_codespaces %}
|
||||
|
||||
{% data reusables.codespaces.availability %}
|
||||
|
||||
When you have access to {% data variables.product.prodname_codespaces %}, you'll see a "Codespaces" tab within the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu when you view a repository.
|
||||
|
||||
You'll have access to codespaces under the following conditions:
|
||||
|
||||
* You are a member of an organization that has enabled {% data variables.product.prodname_codespaces %} and set a spending limit.
|
||||
* An organization owner has granted you access to {% data variables.product.prodname_codespaces %}.
|
||||
* The repository is owned by the organization that has enabled {% data variables.product.prodname_codespaces %}.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Individuals who have already joined the beta with their personal {% data variables.product.prodname_dotcom %} account will not lose access to {% data variables.product.prodname_codespaces %}, however {% data variables.product.prodname_codespaces %} for individuals will continue to remain in beta.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
Organization owners can allow all members of the organization to create codespaces, limit codespace creation to selected organization members, or disable codespace creation. For more information about managing access to codespaces within your organization, see "[Enable Codespaces for users in your organization](/codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization#enable-codespaces-for-users-in-your-organization)."
|
||||
|
||||
Before {% data variables.product.prodname_codespaces %} can be used in an organization, an owner or billing manager must have set a spending limit. For more information, see "[About spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces#about-spending-limits-for-codespaces)."
|
||||
|
||||
If you would like to create a codespace for a repository owned by your personal account or another user, and you have permission to create repositories in an organization that has enabled {% data variables.product.prodname_codespaces %}, you can fork user-owned repositories to that organization and then create a codespace for the fork.
|
||||
|
||||
## Creating a codespace
|
||||
|
||||
{% data reusables.repositories.navigate-to-repo %}
|
||||
@@ -49,10 +66,9 @@ When you create a codespace, a number of steps happen to enable full access to y
|
||||
|
||||

|
||||
|
||||
3. Under the repository name, use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**.
|
||||
|
||||

|
||||
|
||||
4. To create a codespace using a Standard machine type, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||
3. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||
|
||||

|
||||
|
||||
If you are a member of an organization and are creating a codespace on a repository owned by that organization, you can select the option of a different machine type. From the dialog, choose a machine type and then click **Create codespace**.
|
||||

|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Deleting a codespace
|
||||
intro: You can delete a codespace you no longer need.
|
||||
permissions: Anyone can delete a codespace owned by their user account.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
redirect_from:
|
||||
- /github/developing-online-with-github-codespaces/deleting-a-codespace
|
||||
- /github/developing-online-with-codespaces/deleting-a-codespace
|
||||
@@ -14,7 +14,7 @@ topics:
|
||||
- Developer
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
{% data reusables.codespaces.concurrent-codespace-limit %}
|
||||
|
||||
@@ -24,10 +24,7 @@ topics:
|
||||
|
||||
{% endnote %}
|
||||
|
||||
1. Navigate to the repository where you created the codespace. Select **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces** and then click {% octicon "gear" aria-label="The Settings gear" %}. This will display all {% data variables.product.prodname_codespaces %} that you have created in the repository.
|
||||

|
||||
|
||||
Alternatively, you can see every codespace owned by your user account at [github.com/codespaces](https://github.com/codespaces).
|
||||
1. Navigate to the "Your Codespaces" page at [github.com/codespaces](https://github.com/codespaces).
|
||||
|
||||
2. To the right of the codespace you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **{% octicon "trash" aria-label="The trash icon" %} Delete**
|
||||

|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: Developing in a codespace
|
||||
intro: 'You can open a codespace on {% data variables.product.product_name %}, then develop using {% data variables.product.prodname_vscode %}''s features.'
|
||||
permissions: Anyone can develop in a codespace owned by their user account.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
permissions: You can develop in codespaces you've created for repositories owned by organizations using {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}.
|
||||
redirect_from:
|
||||
- /github/developing-online-with-github-codespaces/developing-in-a-codespace
|
||||
- /github/developing-online-with-codespaces/developing-in-a-codespace
|
||||
@@ -14,7 +15,7 @@ topics:
|
||||
- Developer
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
## About development with {% data variables.product.prodname_codespaces %}
|
||||
|
||||
@@ -32,7 +33,7 @@ For more information on using {% data variables.product.prodname_vscode %}, see
|
||||
|
||||
{% data reusables.codespaces.connect-to-codespace-from-vscode %}
|
||||
|
||||
{% data reusables.codespaces.use-chrome %} For more information, see "[Troubleshooting your codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)."
|
||||
{% data reusables.codespaces.use-chrome %} For more information, see "[Troubleshooting Codespaces clients](/codespaces/troubleshooting/troubleshooting-codespaces-clients)."
|
||||
|
||||
### Personalizing your codespace
|
||||
|
||||
@@ -57,4 +58,4 @@ The Command Palette allows you to access and manage many features for {% data va
|
||||
2. Click the name of the codespace you want to develop in.
|
||||

|
||||
|
||||
Alternatively, you can see any active codespaces for a repository by navigating to the repository in which it was made and selecting **{% octicon "codespaces" aria-label="The codespaces icon" %} Codespaces**.
|
||||
Alternatively, you can see any active codespaces for a repository by navigating to that repository and selecting **{% octicon "code" aria-label="The code icon" %} Code**. The drop-down menu will display all active codespaces for a repository.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Forwarding ports in your codespace
|
||||
intro: '{% data reusables.codespaces.about-port-forwarding %}'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
redirect_from:
|
||||
@@ -13,7 +14,7 @@ topics:
|
||||
shortTitle: Forward ports
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
## About forwarded ports
|
||||
|
||||
@@ -46,7 +47,7 @@ You can label a port to make the port more easily identifiable in a list.
|
||||
|
||||
## Sharing a port
|
||||
|
||||
If you want to share a forwarded port with others, you can make the port public. After you make a port public, anyone with the port's URL can view the running application without needing to authenticate.
|
||||
If you want to share a forwarded port with others, you need to make the port public. After you make a port public, anyone with the port's URL can view the running application without needing to authenticate.
|
||||
|
||||
{% data reusables.codespaces.navigate-to-ports-tab %}
|
||||
1. Right click the port you want to share, then click **Make Public**.
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Developing in a codespace
|
||||
intro: 'Create a codespace to get started with developing your project inside a dedicated cloud environment. You can use forwarded ports to run your application and even use codespaces inside {% data variables.product.prodname_vscode %}'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
@@ -9,8 +10,10 @@ children:
|
||||
- /creating-a-codespace
|
||||
- /developing-in-a-codespace
|
||||
- /using-source-control-in-your-codespace
|
||||
- /using-codespaces-for-pull-requests
|
||||
- /deleting-a-codespace
|
||||
- /forwarding-ports-in-your-codespace
|
||||
- /changing-the-machine-type-for-your-codespace
|
||||
- /using-codespaces-in-visual-studio-code
|
||||
---
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
title: Using Codespaces for pull requests
|
||||
shortTitle: Pull requests
|
||||
intro: 'You can use {% data variables.product.prodname_codespaces %} in your development workflow to create pull requests, review pull requests, and address review comments.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Codespaces
|
||||
- Visual Studio Code
|
||||
- Developer
|
||||
---
|
||||
|
||||
## About pull requests in {% data variables.product.prodname_codespaces %}
|
||||
|
||||
{% data variables.product.prodname_codespaces %} provides you with many of the capabilities you might need to work with pull requests:
|
||||
|
||||
- [Create a pull request](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace#raising-a-pull-request) - Using either the Terminal and Git commands or the Source Control view, you can create pull requests just as you would on {% data variables.product.prodname_dotcom_the_website %}. If the repository uses a pull request template, you'll be able to use this within the Source Control view.
|
||||
- [Open a pull request](#opening-a-pull-request-in-codespaces) – You can open an existing pull request in a codespace, provided you have codespace access to the branch that is being merged in.
|
||||
- [Review a pull request](#reviewing-a-pull-request-in-codespaces) - Once you have opened a pull request in a codespace, you can use the "GitHub Pull Request" view to add review comments and approve pull requests. You can also use {% data variables.product.prodname_codespaces %} to [view review comments](#view-comments-from-a-review-in-codespaces).
|
||||
|
||||
## Opening a pull request in {% data variables.product.prodname_codespaces %}
|
||||
|
||||
{% data reusables.repositories.sidebar-pr %}
|
||||
|
||||
2. In the list of pull requests, click the pull request you'd like to open in {% data variables.product.prodname_codespaces %}.
|
||||
3. On the right-hand side of your screen, click **{% octicon "code" aria-label="The code icon" %} Code**.
|
||||
4. From the {% data variables.product.prodname_codespaces %} tab, click **New codespace**.
|
||||

|
||||
|
||||
## Reviewing a pull request in {% data variables.product.prodname_codespaces %}
|
||||
|
||||
{% data reusables.codespaces.review-pr %}
|
||||
|
||||
For more information on reviewing a pull request, see "[Reviewing proposed changes in a pull request](/github/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/reviewing-proposed-changes-in-a-pull-request)."
|
||||
|
||||
## View comments from a review in {% data variables.product.prodname_codespaces %}
|
||||
|
||||
Once you have received feedback on a pull request, you can [open it in a codespace](#opening-a-pull-request-in-codespaces) to see the [review comments](#reviewing-a-pull-request-in-codespaces). From there you can respond to comments, add reactions, or dismiss the review.
|
||||
|
||||

|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Using Codespaces in Visual Studio Code
|
||||
intro: 'You can develop in your codespace directly in {% data variables.product.prodname_vscode %} by connecting the {% data variables.product.prodname_github_codespaces %} extension with your account on {% data variables.product.product_name %}.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
redirect_from:
|
||||
- /github/developing-online-with-codespaces/using-codespaces-in-visual-studio-code
|
||||
- /github/developing-online-with-codespaces/connecting-to-your-codespace-from-visual-studio-code
|
||||
@@ -15,7 +16,7 @@ topics:
|
||||
shortTitle: Visual Studio Code
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -78,7 +79,6 @@ You can change the machine type of your codespace at any time.
|
||||
3. Click the codespace that you want to change.
|
||||

|
||||
4. Choose the machine type you want to use.
|
||||

|
||||
|
||||
If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now. Click **Yes** if you want to change the machine type used for this codespace immediately. If you click **No**, or if the codespace is not currently running, the change will take effect the next time the codespace restarts.
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Using source control in your codespace
|
||||
intro: After making changes to a file in your codespace you can quickly commit the changes and push your update to the remote repository.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: how_to
|
||||
@@ -11,7 +12,7 @@ topics:
|
||||
shortTitle: Source control
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
## About source control in {% data variables.product.prodname_codespaces %}
|
||||
|
||||
@@ -50,7 +51,7 @@ You can pull changes from the remote repository into your codespace at any time.
|
||||

|
||||
1. In the drop-down menu, click **Pull**.
|
||||
|
||||
If a dev container has been changed since you created the codespace you can apply the changes by rebuilding the container for the codespace. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)."
|
||||
If the dev container configuration has been changed since you created the codespace, you can apply the changes by rebuilding the container for the codespace. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)."
|
||||
|
||||
## Setting your codespace to automatically fetch new changes
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Deep dive into Codespaces
|
||||
intro: 'Understand how {% data variables.product.prodname_codespaces %} works.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
type: quick_start
|
||||
@@ -24,7 +25,7 @@ Your codespace can be ephemeral if you need to test something or you can return
|
||||
|
||||
Once you've selected the option to create a new codespace, some steps happen in the background before the codespace is available to you.
|
||||
|
||||

|
||||

|
||||
### Step 1: VM and storage are assigned to your codespace
|
||||
|
||||
When you create a codespace, a [shallow clone](https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/) of your repository is made on a Linux virtual machine that is both dedicated and private to you. Having a dedicated VM ensures that you have the entire set of compute resources from that machine available to you. If necessary, this also allows you to have full root access to your container.
|
||||
|
||||
@@ -1,12 +1,11 @@
|
||||
---
|
||||
title: 'Getting Started with {% data variables.product.prodname_codespaces %}'
|
||||
intro: 'Learn how to get started with {% data variables.product.prodname_codespaces %}, including set up and configuration for specific languages.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
children:
|
||||
- /quickstart
|
||||
- /deep-dive
|
||||
---
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Quickstart for Codespaces
|
||||
intro: 'Try out {% data variables.product.prodname_codespaces %} in 5 minutes.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
type: quick_start
|
||||
@@ -11,8 +12,6 @@ redirect_from:
|
||||
- /codespaces/codespaces-quickstart
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
## Introduction
|
||||
|
||||
In this guide, you'll create a codespace from a [template repository](https://github.com/2percentsilk/haikus-for-codespaces) and explore some of the essential features available to you within the codespace.
|
||||
@@ -27,11 +26,7 @@ For more information on exactly how {% data variables.product.prodname_codespace
|
||||
|
||||
2. Name your repository, select your preferred privacy setting, and click **Create repository from this template**.
|
||||
|
||||
3. Navigate to the main page of the newly created repository. Under the repository name, use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**.
|
||||
|
||||

|
||||
|
||||
4. To create a codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||
3. Navigate to the main page of the newly created repository. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||
|
||||

|
||||
|
||||
|
||||
@@ -1,15 +1,19 @@
|
||||
---
|
||||
title: Codespaces guides
|
||||
shortTitle: Guides
|
||||
intro: 'Learn how to make the most of GitHub {% data reusables.gated-features.codespaces %}'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
intro: 'Learn how to make the most of GitHub'
|
||||
allowTitleToDifferFromFilename: true
|
||||
layout: product-sublanding
|
||||
versions:
|
||||
fpt: '*'
|
||||
includeGuides:
|
||||
- /codespaces/quickstart
|
||||
- /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces
|
||||
- /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces
|
||||
- /codespaces/getting-started/quickstart
|
||||
- /codespaces/getting-started/deep-dive
|
||||
- /codespaces/setting-up-your-project-for-codespaces/setting-up-your-nodejs-project-for-codespaces
|
||||
- /codespaces/setting-up-your-project-for-codespaces/setting-up-your-python-project-for-codespaces
|
||||
- /codespaces/setting-up-your-project-for-codespaces/setting-up-your-dotnet-project-for-codespaces
|
||||
- /codespaces/setting-up-your-project-for-codespaces/setting-up-your-java-project-for-codespaces
|
||||
- /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project
|
||||
- /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account
|
||||
- /codespaces/developing-in-codespaces/creating-a-codespace
|
||||
@@ -18,11 +22,19 @@ includeGuides:
|
||||
- /codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace
|
||||
- /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code
|
||||
- /codespaces/developing-in-codespaces/using-source-control-in-your-codespace
|
||||
- /codespaces/developing-in-codespaces/using-codespaces-for-pull-requests
|
||||
- /codespaces/developing-in-codespaces/changing-the-machine-type-for-your-codespace
|
||||
- /codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces
|
||||
- /codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces
|
||||
- /codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces
|
||||
- /codespaces/managing-your-codespaces/managing-gpg-verification-for-codespaces
|
||||
- /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces
|
||||
- /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization
|
||||
- /codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces
|
||||
- /codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces
|
||||
- /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces
|
||||
- /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization
|
||||
- /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces
|
||||
---
|
||||
|
||||
- /codespaces/managing-codespaces-for-your-organization/managing-billing-for-codespaces-in-your-organization
|
||||
- /codespaces/managing-codespaces-for-your-organization/managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces
|
||||
- /codespaces/codespaces-reference/understanding-billing-for-codespaces
|
||||
- /codespaces/codespaces-reference/using-the-command-palette-in-codespaces
|
||||
- /codespaces/codespaces-reference/disaster-recovery-for-codespaces
|
||||
- /codespaces/codespaces-reference/security-in-codespaces
|
||||
@@ -1,6 +1,5 @@
|
||||
---
|
||||
title: GitHub Codespaces Documentation
|
||||
beta_product: true
|
||||
shortTitle: GitHub Codespaces
|
||||
intro: 'Create a codespace to start developing in a secure, configurable, and dedicated development environment that works how and where you want it to.'
|
||||
introLinks:
|
||||
@@ -8,21 +7,22 @@ introLinks:
|
||||
quickstart: /codespaces/getting-started/quickstart
|
||||
featuredLinks:
|
||||
guides:
|
||||
- /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces
|
||||
- /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization
|
||||
- /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project
|
||||
- /codespaces/managing-codespaces-for-your-organization/managing-repository-access-for-your-organizations-codespaces
|
||||
- /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces
|
||||
popular:
|
||||
- /codespaces/getting-started-with-codespaces/getting-started-with-your-nodejs-project-in-codespaces
|
||||
- /codespaces/getting-started-with-codespaces/getting-started-with-your-python-project-in-codespaces
|
||||
- /codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces
|
||||
- /codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project
|
||||
guideCards:
|
||||
- /codespaces/getting-started/deep-dive
|
||||
- /codespaces/developing-in-codespaces/creating-a-codespace
|
||||
- /codespaces/developing-in-codespaces/developing-in-a-codespace
|
||||
- /codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code
|
||||
- /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account
|
||||
popular:
|
||||
- /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project
|
||||
- /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization
|
||||
- /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces
|
||||
- /codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-codespaces
|
||||
popularHeading: Managing GitHub Codespaces
|
||||
popularHeading: Set up your project
|
||||
product_video: 'https://www.youtube-nocookie.com/embed/_W9B7qc9lVc'
|
||||
redirect_from:
|
||||
- /github/developing-online-with-github-codespaces
|
||||
@@ -40,6 +40,7 @@ children:
|
||||
- /managing-your-codespaces
|
||||
- /managing-codespaces-for-your-organization
|
||||
- /codespaces-reference
|
||||
- /troubleshooting
|
||||
- /guides
|
||||
---
|
||||
|
||||
|
||||
@@ -0,0 +1,54 @@
|
||||
---
|
||||
title: Enabling Codespaces for your organization
|
||||
shortTitle: Enabling Codespaces
|
||||
intro: 'You can control which users in your organization can use {% data variables.product.prodname_codespaces %}.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
permissions: 'To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.'
|
||||
redirect_from:
|
||||
- /codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Codespaces
|
||||
- Permissions
|
||||
- Administrator
|
||||
---
|
||||
|
||||
|
||||
## About enabling {% data variables.product.prodname_codespaces %} for your organization
|
||||
|
||||
Organization owners can control which users in your organization can create and use codespaces.
|
||||
|
||||
To use codespaces in your organization, you must do the following:
|
||||
|
||||
- Ensure that users have [at least write access](/organizations/managing-access-to-your-organizations-repositories/repository-permission-levels-for-an-organization) to the repositories where they want to use a codespace.
|
||||
- [Enable {% data variables.product.prodname_codespaces %} for users in your organization](#configuring-which-users-in-your-organization-can-use-codespaces). You can choose allow {% data variables.product.prodname_codespaces %} for selected users or only for specific users.
|
||||
- [Set a spending limit](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces)
|
||||
|
||||
By default, a codespace can only access the repository from which it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)."
|
||||
|
||||
## Enable {% data variables.product.prodname_codespaces %} for users in your organization
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.organizations.click-codespaces %}
|
||||
1. Under "User permissions", select one of the following options:
|
||||
|
||||
* **Allow for all users** to allow all your organization members to use {% data variables.product.prodname_codespaces %}.
|
||||
* **Selected users** to select specific organization members to use {% data variables.product.prodname_codespaces %}.
|
||||
|
||||

|
||||
|
||||
## Disabling {% data variables.product.prodname_codespaces %} for your organization
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.organizations.click-codespaces %}
|
||||
1. Under "User permissions", select **Disabled**.
|
||||
|
||||
## Setting a spending limit
|
||||
|
||||
{% data reusables.codespaces.codespaces-spending-limit-requirement %}
|
||||
|
||||
For information on managing and changing your account's spending limit, see "[Managing your spending limit for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)."
|
||||
@@ -1,15 +1,17 @@
|
||||
---
|
||||
title: Managing Codespaces for your organization
|
||||
intro: 'You can manage and review how users in your organization can use {% data variables.product.prodname_github_codespaces %}.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- Codespaces
|
||||
children:
|
||||
- /enabling-codespaces-for-your-organization
|
||||
- /managing-billing-for-codespaces-in-your-organization
|
||||
- /managing-encrypted-secrets-for-your-repository-and-organization-for-codespaces
|
||||
- /managing-access-and-security-for-your-organizations-codespaces
|
||||
- /managing-user-permissions-for-your-organization
|
||||
- /managing-repository-access-for-your-organizations-codespaces
|
||||
- /reviewing-your-organizations-audit-logs-for-codespaces
|
||||
shortTitle: Manage your organization
|
||||
shortTitle: Managing your organization
|
||||
---
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Managing billing for Codespaces in your organization
|
||||
shortTitle: Managing billing for Codespaces
|
||||
intro: 'You can check your {% data variables.product.prodname_codespaces %} usage and set usage limits.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
permissions: 'To manage billing for Codespaces for an organization, you must be an organization owner or a billing manager.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
- Billing
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
{% data reusables.codespaces.codespaces-billing %}
|
||||
|
||||
- You can manage Codespaces billing for your organization: ["About billing for Codespaces"](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces)
|
||||
|
||||
|
||||
- For users, there is a guide that explains how billing works ["Understanding billing for Codespaces"](/codespaces/codespaces-reference/understanding-billing-for-codespaces)
|
||||
|
||||
## Usage limits
|
||||
|
||||
You can set a usage limit for the codespaces in your organization or repository. This limit is applied to the compute and storage usage for {% data variables.product.prodname_codespaces %}:
|
||||
|
||||
- **Compute minutes:** Compute usage is calculated by the actual number of minutes used by all {% data variables.product.prodname_codespaces %} instances while they are active. These totals are reported to the billing service daily, and is billed monthly. You can set a spending limit for {% data variables.product.prodname_codespaces %} usage in your organization. For more information, see "[Managing spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)."
|
||||
|
||||
- **Storage usage:** For {% data variables.product.prodname_codespaces %} billing purposes, this includes all storage used by all codespaces in your account. This includes all used by the codespaces, such as cloned repositories, configuration files, and extensions, among others. These totals are reported to the billing service daily, and is billed monthly. At the end of the month, {% data variables.product.prodname_dotcom %} rounds your storage to the nearest MB. To check how many compute minutes and storage GB have been used by {% data variables.product.prodname_codespaces %}, see "[Viewing your Codespaces usage"](/billing/managing-billing-for-github-codespaces/viewing-your-codespaces-usage)."
|
||||
|
||||
## Disabling or limiting {% data variables.product.prodname_codespaces %}
|
||||
|
||||
You can disable the use of {% data variables.product.prodname_codespaces %} in your organization or repository. For more information, see "[Managing repository access for your organization's codespaces](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)."
|
||||
|
||||
You can also limit the individual users who can use {% data variables.product.prodname_codespaces %}. For more information, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)."
|
||||
|
||||
## Deleting unused codespaces
|
||||
|
||||
Your users can delete their codespaces in https://github.com/codespaces and from within Visual Studio Code. To reduce the size of a codespace, users can manually delete files using the terminal or from within Visual Studio Code.
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** Only the person who created a codespace can delete it. There is currently no way for organization owners to delete codespaces created within their organization.
|
||||
|
||||
{% endnote %}
|
||||
@@ -1,15 +1,18 @@
|
||||
---
|
||||
title: Managing encrypted secrets for your repository and organization for Codespaces
|
||||
shortTitle: Managing secrets for your repository and organization
|
||||
shortTitle: Encrypted secrets
|
||||
intro: 'Encrypted secrets allow you to store sensitive information in your organization, repository, or {% data variables.product.prodname_codespaces %}.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
permissions: 'To manage secrets for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- Codespaces
|
||||
- Secret store
|
||||
- Security
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
## About secrets
|
||||
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: Managing access and security for your organization's codespaces
|
||||
shortTitle: Managing access and security for your organization
|
||||
title: Managing repository access for your organization's codespaces
|
||||
shortTitle: Repository access
|
||||
intro: 'You can manage the repositories in your organization that {% data variables.product.prodname_codespaces %} can access.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
permissions: 'To manage access and security for Codespaces for an organization, you must be an organization owner.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
@@ -11,15 +12,12 @@ topics:
|
||||
- Security
|
||||
- Administrator
|
||||
redirect_from:
|
||||
- /codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces
|
||||
- /github/developing-online-with-codespaces/managing-access-and-security-for-codespaces
|
||||
- /codespaces/working-with-your-codespace/managing-access-and-security-for-codespaces
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
Organization owners can manage which repositories a codespace can access.
|
||||
|
||||
By default, a codespace can only access the repository where it was created. When you enable access and security for a repository owned by your organization, any codespaces that are created for that repository will also have read permissions to all other repositories the organization owns and the codespace creator has permissions to access. If you want to restrict the repositories a codespace can access, you can limit access to either the repository where the codespace was created, or to specific repositories. You should only enable access and security for repositories you trust.
|
||||
By default, a codespace can only access the repository where it was created. When you enable access and security for a repository owned by your organization, any codespaces that are created for that repository will also have read and write permissions to all other repositories the organization owns and the codespace creator has permissions to access. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository where the codespace was created, or to specific repositories. You should only enable access and security for repositories you trust.
|
||||
|
||||
To manage which users in your organization can use {% data variables.product.prodname_codespaces %}, see "[Managing user permissions for your organization](/codespaces/managing-codespaces-for-your-organization/managing-user-permissions-for-your-organization)."
|
||||
|
||||
@@ -1,36 +0,0 @@
|
||||
---
|
||||
title: Managing user permissions for your organization
|
||||
intro: 'You can control which users in your organization can use {% data variables.product.prodname_codespaces %}.'
|
||||
permissions: 'To manage user permissions for {% data variables.product.prodname_codespaces %} for an organization, you must be an organization owner.'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: how_to
|
||||
topics:
|
||||
- Codespaces
|
||||
- Permissions
|
||||
- Administrator
|
||||
shortTitle: User permissions
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
## About user permissions for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
Organization owners can control which users in your organization can create and use codespaces.
|
||||
|
||||
To use codespaces in your organization, your users must have at least write access to the repositories where they want to use a codespace. You can enable codespaces for all users in your organization, or only specific users.
|
||||
|
||||
By default, a codespace can only access the repository where it was created. If you want codespaces in your organization to be able to access other organization repositories that the codespace creator can access, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/codespaces/managing-codespaces-for-your-organization/managing-access-and-security-for-your-organizations-codespaces)."
|
||||
|
||||
## Configuring which users in your organization can use {% data variables.product.prodname_codespaces %}
|
||||
|
||||
{% data reusables.profile.access_org %}
|
||||
{% data reusables.profile.org_settings %}
|
||||
{% data reusables.organizations.click-codespaces %}
|
||||
1. Under "User permissions", select one of the following options:
|
||||
|
||||
* **Disabled** to not allow any organization members to use {% data variables.product.prodname_codespaces %}.
|
||||
* **Allow for all users** to allow all your organization members to use {% data variables.product.prodname_codespaces %}.
|
||||
* **Selected users** to select specific organization members to use {% data variables.product.prodname_codespaces %}.
|
||||
|
||||

|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: Reviewing your organization's audit logs for Codespaces
|
||||
shortTitle: Reviewing your organization's audit logs
|
||||
shortTitle: Audit logs
|
||||
intro: 'You can use the audit log to review all actions related to {% data variables.product.prodname_codespaces %}.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: how_to
|
||||
@@ -11,7 +12,7 @@ topics:
|
||||
- Administrator
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
When any member of your organization performs an action related to {% data variables.product.prodname_codespaces %}, you can review the actions in the audit log. For information about accessing the log, see "[Reviewing your audit log](/organizations/keeping-your-organization-secure/reviewing-the-audit-log-for-your-organization#accessing-the-audit-log)."
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Managing your codespaces
|
||||
intro: 'You can use {% data variables.product.prodname_github_codespaces %} settings to manage information that your codespace might need.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
@@ -9,8 +10,10 @@ redirect_from:
|
||||
- /codespaces/working-with-your-codespace
|
||||
children:
|
||||
- /managing-encrypted-secrets-for-your-codespaces
|
||||
- /managing-access-and-security-for-your-codespaces
|
||||
- /managing-repository-access-for-your-codespaces
|
||||
- /reviewing-your-security-logs-for-codespaces
|
||||
- /managing-gpg-verification-for-codespaces
|
||||
- /setting-your-default-editor-for-codespaces
|
||||
- /setting-your-default-region-for-codespaces
|
||||
---
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: Managing encrypted secrets for your 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:
|
||||
fpt: '*'
|
||||
redirect_from:
|
||||
@@ -11,10 +12,11 @@ topics:
|
||||
- Codespaces
|
||||
- Developer
|
||||
- Security
|
||||
- Secret store
|
||||
shortTitle: Encrypted secrets
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
|
||||
## About encrypted secrets for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
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:
|
||||
fpt: '*'
|
||||
type: how_to
|
||||
@@ -14,10 +15,12 @@ redirect_from:
|
||||
shortTitle: GPG verification
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
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)."
|
||||
|
||||
Once you enable GPG verification, it will immediately take effect for all your codespaces.
|
||||
|
||||
{% 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,14 +1,17 @@
|
||||
---
|
||||
title: Managing access and security for your codespaces
|
||||
title: Managing repository access for your codespaces
|
||||
shortTitle: Repository access
|
||||
intro: 'You can manage the repositories that {% data variables.product.prodname_codespaces %} can access.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Access & security
|
||||
redirect_from:
|
||||
- /codespaces/managing-your-codespaces/managing-access-and-security-for-your-codespaces
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
When you enable access and security for a repository owned by your user account, any codespaces that are created for that repository will have read permissions to all other repositories you own. If you want to restrict the repositories a codespace can access, you can limit to it to either the repository the codespace was opened for or specific repositories. You should only enable access and security for repositories you trust.
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
title: Reviewing your security logs for Codespaces
|
||||
shortTitle: Reviewing your security logs
|
||||
shortTitle: Security logs
|
||||
intro: 'You can use the security log to review all actions related to {% data variables.product.prodname_codespaces %}.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
@@ -10,7 +11,7 @@ topics:
|
||||
- Security
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
## About security logs for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
|
||||
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Setting your default editor for Codespaces
|
||||
intro: 'You can set your default editor for {% data variables.product.prodname_codespaces %} in your personal settings page.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Set the default editor
|
||||
---
|
||||
|
||||
On the settings page, you can set your editor preference so that any newly created codespaces are opened automatically in either {% data variables.product.prodname_vscode %} for Web or the {% data variables.product.prodname_vscode %} desktop application.
|
||||
|
||||
If you want to use {% data variables.product.prodname_vscode %} as your default editor for {% data variables.product.prodname_codespaces %}, you need to install {% data variables.product.prodname_vscode %} and the {% data variables.product.prodname_github_codespaces %} extension for {% data variables.product.prodname_vscode %}. For more information, see the [download page for {% data variables.product.prodname_vscode %}](https://code.visualstudio.com/download/) and the [{% data variables.product.prodname_github_codespaces %} extension on the {% data variables.product.prodname_vscode %} marketplace](https://marketplace.visualstudio.com/items?itemName=GitHub.codespaces).
|
||||
|
||||
## Setting your default editor
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.codespaces-tab %}
|
||||
1. Under "Editor preference", select the option you want.
|
||||

|
||||
If you choose **{% data variables.product.prodname_vscode %}**, {% data variables.product.prodname_codespaces %} will automatically open in the desktop application when you next create a codespace. You may need to allow access to both your browser and {% data variables.product.prodname_vscode %} for it to open successfully.
|
||||

|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: Setting your default region for Codespaces
|
||||
intro: 'You can set your default region in the {% data variables.product.prodname_github_codespaces %} profile settings page to personalize where your data is held.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Set the default region
|
||||
---
|
||||
|
||||
You can manually select the region that your codespaces will be created in, allowing you to meet stringent security and compliance requirements. By default, your region is set automatically, based on your location.
|
||||
|
||||
## Setting your default region
|
||||
|
||||
{% data reusables.user_settings.access_settings %}
|
||||
{% data reusables.user_settings.codespaces-tab %}
|
||||
1. Under "Region", select the setting you want.
|
||||
2. If you chose "Set manually", select your region in the drop-down list.
|
||||

|
||||
@@ -1,10 +1,15 @@
|
||||
---
|
||||
title: GitHub Codespaces overview
|
||||
shortTitle: Overview
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
intro: 'This guide introduces {% data variables.product.prodname_codespaces %} and provides details on how it works and how to use it.'
|
||||
allowTitleToDifferFromFilename: true
|
||||
redirect_from:
|
||||
- /codespaces/codespaces-reference/about-codespaces
|
||||
- /github/developing-online-with-github-codespaces/about-github-codespaces
|
||||
- /github/developing-online-with-codespaces/about-codespaces
|
||||
- /codespaces/getting-started-with-codespaces/about-codespaces
|
||||
- /codespaces/about-codespaces
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
type: quick_start
|
||||
@@ -32,8 +37,7 @@ You can also personalize aspects of your codespace environment by using a public
|
||||
|
||||
## About billing for {% data variables.product.prodname_codespaces %}
|
||||
|
||||
{% data reusables.codespaces.about-billing-for-codespaces %} For more information, see "[About billing for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-billing-for-codespaces)."
|
||||
{% data reusables.codespaces.codespaces-trial-period %}
|
||||
|
||||
## Joining the beta
|
||||
For information on billing for {% data variables.product.prodname_codespaces %}, see "[About billing for {% data variables.product.prodname_codespaces %}](/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces)."
|
||||
|
||||
A limited number of people will be invited to join the beta. To join the waitlist, see [Sign up for the Codespaces beta](https://github.com/features/codespaces/signup).
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
---
|
||||
title: 'Setting up your project for {% data variables.product.prodname_codespaces %}'
|
||||
intro: 'Learn how to get started with {% data variables.product.prodname_codespaces %}, including set up and configuration for specific languages.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
free-pro-team: '*'
|
||||
redirect_from:
|
||||
@@ -11,4 +12,3 @@ children:
|
||||
- /setting-up-your-java-project-for-codespaces
|
||||
- /setting-up-your-python-project-for-codespaces
|
||||
---
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Setting up your C# (.NET) project for Codespaces
|
||||
shortTitle: Setting up your C# (.NET) project
|
||||
allowTitleToDifferFromFilename: true
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
intro: 'Get started with your C# (.NET) project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.'
|
||||
redirect_from:
|
||||
- /codespaces/getting-started-with-codespaces/getting-started-with-your-dotnet-project
|
||||
@@ -11,7 +12,7 @@ topics:
|
||||
- Codespaces
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
## Introduction
|
||||
|
||||
@@ -24,13 +25,12 @@ This guide shows you how to set up your C# (.NET) project in {% data variables.p
|
||||
|
||||
## Step 1: Open your project in a codespace
|
||||
|
||||
1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}.
|
||||
1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||
|
||||

|
||||
|
||||
2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||

|
||||
|
||||
If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
|
||||
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including .NET. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
|
||||
|
||||
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Setting up your Java project for Codespaces
|
||||
shortTitle: Setting up with your Java project
|
||||
intro: 'Get started with your Java project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
redirect_from:
|
||||
- /codespaces/getting-started-with-codespaces/getting-started-with-your-java-project-in-codespaces
|
||||
versions:
|
||||
@@ -10,7 +11,7 @@ topics:
|
||||
- Codespaces
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
## Introduction
|
||||
|
||||
@@ -23,13 +24,12 @@ This guide shows you how to set up your Java project in {% data variables.produc
|
||||
|
||||
## Step 1: Open your project in a codespace
|
||||
|
||||
1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}.
|
||||
1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||
|
||||

|
||||
|
||||
2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||

|
||||
|
||||
If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
|
||||
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Java, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
|
||||
|
||||
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Setting up your Node.js project for Codespaces
|
||||
shortTitle: Setting up your Node.js project
|
||||
intro: 'Get started with your JavaScript, Node.js, or TypeScript project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
redirect_from:
|
||||
@@ -14,7 +15,7 @@ topics:
|
||||
- JavaScript
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
## Introduction
|
||||
|
||||
@@ -27,13 +28,13 @@ This guide shows you how to set up your JavaScript, Node.js, or TypeScript proje
|
||||
|
||||
## Step 1: Open your project in a codespace
|
||||
|
||||
1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}.
|
||||
1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||
|
||||

|
||||
|
||||
2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||

|
||||
|
||||
If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
|
||||
|
||||
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
|
||||
|
||||
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
|
||||
|
||||
@@ -2,6 +2,7 @@
|
||||
title: Setting up your Python project for Codespaces
|
||||
shortTitle: Setting up your Python project
|
||||
intro: 'Get started with your Python project in {% data variables.product.prodname_codespaces %} by creating a custom dev container.'
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
redirect_from:
|
||||
@@ -14,7 +15,7 @@ topics:
|
||||
- Python
|
||||
---
|
||||
|
||||
{% data reusables.codespaces.release-stage %}
|
||||
|
||||
|
||||
## Introduction
|
||||
|
||||
@@ -27,13 +28,14 @@ This guide shows you how to set up your Python project in {% data variables.prod
|
||||
|
||||
## Step 1: Open your project in a codespace
|
||||
|
||||
1. Navigate to your project's repository. Use the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and select **Open with Codespaces**. If you don’t see this option, your project isn’t available for {% data variables.product.prodname_codespaces %}.
|
||||
1. Under the repository name, use the **{% octicon "code" aria-label="The code icon" %} Code** drop-down menu, and in the **Codespaces** tab, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||
|
||||

|
||||
|
||||
2. To create a new codespace, click {% octicon "plus" aria-label="The plus icon" %} **New codespace**.
|
||||

|
||||
|
||||
If you don’t see this option, {% data variables.product.prodname_codespaces %} isn't available for your project. See [Access to {% data variables.product.prodname_codespaces %}](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces) for more information.
|
||||
|
||||
|
||||
|
||||
When you create a codespace, your project is created on a remote VM that is dedicated to you. By default, the container for your codespace has many languages and runtimes including Node.js, JavaScript, Typescript, nvm, npm, and yarn. It also includes a common set of tools like git, wget, rsync, openssh, and nano.
|
||||
|
||||
You can customize your codespace by adjusting the amount of vCPUs and RAM, [adding dotfiles to personalize your environment](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account), or by modifying the tools and scripts installed.
|
||||
|
||||
55
content/codespaces/troubleshooting/codespaces-logs.md
Normal file
@@ -0,0 +1,55 @@
|
||||
---
|
||||
title: Codespaces logs
|
||||
intro: Overview of the logging locations used by {% data variables.product.prodname_codespaces %}.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
- Logging
|
||||
shortTitle: Codespaces logs
|
||||
---
|
||||
|
||||
|
||||
Information on {% data variables.product.prodname_codespaces %} is output to three different logs:
|
||||
|
||||
- Codespace logs
|
||||
- Creation logs
|
||||
- Extension logs ({% data variables.product.prodname_vscode %} desktop) or Browser console logs ({% data variables.product.prodname_vscode %} in the web)
|
||||
|
||||
## Codespace logs
|
||||
|
||||
These logs contain detailed information about the codespace, the container, the session, and the {% data variables.product.prodname_vscode %} environment. They are useful for diagnosing connection issues and other unexpected behavior. For example, the codespace freezes but the "Reload Windows" option unfreezes it for a few minutes, or you are randomly disconnected from the codespace but able to reconnect immediately.
|
||||
|
||||
1. If you are using {% data variables.product.prodname_codespaces %} in the browser, ensure that you are connected to the codespace you want to debug.
|
||||
2. Open the Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Export logs**. Select **Codespaces: Export Logs** from the list to download the logs.
|
||||
3. Define where to save the zip archive of logs then click **Save** (desktop) or click **OK** (web).
|
||||
4. If you are using {% data variables.product.prodname_codespaces %} in the browser, right-click on the zip archive of logs from the Explorer view and select **Download…** to download them to your local machine.
|
||||
|
||||
## Creation logs
|
||||
|
||||
These logs contain information about the container, dev container, and their configuration. They are useful for debugging configuration and setup problems.
|
||||
|
||||
1. Connect to the codespace you want to debug.
|
||||
2. Open the Command Palette (`Shift + Command + P` (Mac) / `Ctrl + Shift + P` (Windows)) and type **Creation logs**. Select **Codespaces: View Creation Log** from the list to open the `creation.log` file.
|
||||
|
||||
If you want to share the log with support, you can copy the text from the creation log into a text editor and save the file locally.
|
||||
|
||||
## Extension logs
|
||||
|
||||
These logs are available for {% data variables.product.prodname_vscode %} desktop users only. They are useful if it seems like the {% data variables.product.prodname_codespaces %} extension or {% data variables.product.prodname_vscode %} editor are having issues that prevent creation or connection.
|
||||
|
||||
1. In {% data variables.product.prodname_vscode %}, open the Command Palette.
|
||||
2. Type **Logs** and select **Developer: Open Extension Logs Folder** from the list to open the extension log folder in your system's file explorer.
|
||||
|
||||
From this view, you can access logs generated by the various extensions that you use in {% data variables.product.prodname_vscode %}. You will see logs for GitHub Codespaces, GitHub Authentication, and Git, in addition to any other extensions you have enabled.
|
||||
|
||||
## Browser console logs
|
||||
|
||||
These logs are useful only if you want to debug problems with using {% data variables.product.prodname_codespaces %} in the browser. They are useful for debugging problems creating and connecting to {% data variables.product.prodname_codespaces %}.
|
||||
|
||||
1. In the browser window for the codespace you want to debug, open the developer tools window.
|
||||
2. Display the "Console" tab and click **errors** in the left side bar to show only the errors.
|
||||
3. In the log area on the right, right-click and select **Save as** to save a copy of the errors to your local machine.
|
||||

|
||||
21
content/codespaces/troubleshooting/index.md
Normal file
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: Troubleshooting Codespaces
|
||||
shortTitle: Troubleshooting
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
intro: 'These guides provide information for troubleshooting {% data variables.product.prodname_codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
redirect_from:
|
||||
- /codespaces/codespaces-reference/troubleshooting-your-codespace
|
||||
- /github/developing-online-with-github-codespaces/troubleshooting-your-codespace
|
||||
- /github/developing-online-with-codespaces/troubleshooting-your-codespace
|
||||
- /codespaces/working-with-your-codespace/troubleshooting-your-codespace
|
||||
children:
|
||||
- /troubleshooting-creation-and-deletion-of-codespaces
|
||||
- /troubleshooting-your-connection-to-codespaces
|
||||
- /troubleshooting-dotfiles-for-codespaces
|
||||
- /troubleshooting-port-forwarding-for-codespaces
|
||||
- /troubleshooting-codespaces-clients
|
||||
- /codespaces-logs
|
||||
- /working-with-support-for-codespaces
|
||||
---
|
||||
@@ -0,0 +1,25 @@
|
||||
---
|
||||
title: Troubleshooting Codespaces clients
|
||||
intro: You can use {% data variables.product.prodname_codespaces %} in your browser or through {% data variables.product.prodname_vscode %}. This article provides troubleshooting steps for common client issues.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Codespaces clients
|
||||
---
|
||||
|
||||
## {% data variables.product.prodname_vscode %} troubleshooting
|
||||
|
||||
When you connect a desktop version of {% data variables.product.prodname_vscode %} to a codespace, you will notice few differences compared with working in a normal workspace but the experience will be fairly similar.
|
||||
|
||||
When you open a codespace in your browser using {% data variables.product.prodname_vscode %} in the web, you will notice more differences. For example, some key bindings will be different or missing, and some extensions may behave differently. For a summary, see: "[Known limitations and adaptions](https://code.visualstudio.com/docs/remote/codespaces#_known-limitations-and-adaptations)" in the {% data variables.product.prodname_vscode %} docs.
|
||||
|
||||
You can check for known issues and log new issues with the {% data variables.product.prodname_vscode %} experience in the [`microsoft/vscode`](https://github.com/microsoft/vscode/issues?q=is%3Aissue+is%3Aopen+codespaces) repository.
|
||||
|
||||
## Browser troubleshooting
|
||||
|
||||
If you encounter issues using codespaces in a browser that is not Chromium-based, try switching to a Chromium-based browser, or check for known issues with your browser in the `microsoft/vscode` repository by searching for issues labeled with the name of your browser, such as [`firefox`](https://github.com/microsoft/vscode/issues?q=is%3Aissue+is%3Aopen+label%3Afirefox) or [`safari`](https://github.com/Microsoft/vscode/issues?q=is%3Aopen+is%3Aissue+label%3Asafari).
|
||||
|
||||
If you encounter issues using codespaces in a Chromium-based browser, you can check if you're experiencing another known issue with {% data variables.product.prodname_vscode %} in the [`microsoft/vscode`](https://github.com/microsoft/vscode/issues) repository.
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
title: Troubleshooting creation and deletion of Codespaces
|
||||
intro: This article provides troubleshooting steps for common issues you may experience when creating or deleting a codespace, including storage and configuration issues.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Creation and deletion
|
||||
---
|
||||
|
||||
## Creating codespaces
|
||||
|
||||
{% data variables.product.prodname_codespaces %} are not available for all repositories. If the “Open with Codespaces” button is missing, {% data variables.product.prodname_codespaces %} may not be available for that repository. For more information, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#access-to-codespaces)."
|
||||
|
||||
If you create a codespace and it does not open:
|
||||
|
||||
1. Try reloading the page in case there was a caching or reporting problem.
|
||||
2. Go to your {% data variables.product.prodname_codespaces %} page: https://github.com/codespaces and check whether the new codespace is listed there. The process may have successfully created the codespace but failed to report back to your browser. If the new codespace is listed, you can open it directly from that page.
|
||||
3. Retry creating the codespace for the repository to rule out a transient communication failure.
|
||||
|
||||
If you still cannot create a codespace for a repository where {% data variables.product.prodname_codespaces %} are available, {% data reusables.codespaces.contact-support %}
|
||||
|
||||
## Deleting codespaces
|
||||
|
||||
The owner of a codespace has full control over it and only they can delete their codespaces. You cannot delete a codespace created by another user.
|
||||
|
||||
## Container storage
|
||||
|
||||
When you create a codespace, it has a finite amount of storage and over time it may be necessary for you to free up space. Try running any of the following commands in the {% data variables.product.prodname_codespaces %} terminal to free up storage space.
|
||||
|
||||
- Remove packages that are no longer used by using `sudo apt autoremove`.
|
||||
- Clean the apt cache by using `sudo apt clean`.
|
||||
- See the top 10 largest files in the codespace with`sudo find / -printf '%s %p\n'| sort -nr | head -10`.
|
||||
- Delete unneeded files, such as build artifacts and logs.
|
||||
|
||||
Some more destructive options:
|
||||
|
||||
- Remove unused Docker images, networks, and containers by using `docker system prune` (append `-a` if you want to remove all images, and `--volumes` if you want to remove all volumes).
|
||||
- Remove untracked files from working tree: `git clean -i`.
|
||||
|
||||
## Configuration
|
||||
|
||||
{% data reusables.codespaces.recovery-mode %}
|
||||
|
||||
```
|
||||
This codespace is currently running in recovery mode due to a container error.
|
||||
```
|
||||
|
||||
Review the creation logs, update the configuration as needed, and run **Codespaces: Rebuild Container** in the command palette to retry. For more information, see " [Codespaces logs](/codespaces/troubleshooting/codespaces-logs)" and "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)."
|
||||
@@ -0,0 +1,21 @@
|
||||
---
|
||||
title: Troubleshooting dotfiles for Codespaces
|
||||
intro: Troubleshooting steps for common dotfiles issues.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Dotfiles
|
||||
---
|
||||
|
||||
If your codespace fails to pick up configuration settings from dotfiles, you should work through the following debugging steps.
|
||||
|
||||
1. Make sure your dotfiles repository is public. If you have secrets or sensitive data you want to use in your codespace, use [Codespace secrets](/codespaces/managing-your-codespaces/managing-encrypted-secrets-for-your-codespaces) instead of private dotfiles.
|
||||
2. Check `/workspaces/.codespaces/.persistedshare/dotfiles` to see if your dotfiles were cloned.
|
||||
- If your dotfiles were cloned, try manually re-running your install script to verify that it is executable.
|
||||
- If your dotfiles were not cloned, check `/workspaces/.codespaces/.persistedshare/EnvironmentLog.txt` to see if there was a problem cloning them.
|
||||
3. Check `/workspaces/.codespaces/.persistedshare/creation.log` for possible issues. For more information, see [Creation logs](/codespaces/troubleshooting/codespaces-logs#creation-logs).
|
||||
|
||||
If the configuration from your dotfiles is correctly picked up, but part of the configuration is incompatible with codespaces, use the `$CODESPACES` environment variable to add conditional logic for codespace-specific configuration settings.
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
title: Troubleshooting port forwarding for Codespaces
|
||||
intro: Troubleshooting steps for common port forwarding issues.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Port forwarding
|
||||
---
|
||||
|
||||
When an application running inside a codespace outputs a port to the console, {% data variables.product.prodname_codespaces %} detects the localhost URL pattern and automatically forwards the port. For more information, see "[Forwarding ports in your codespace](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace)."
|
||||
|
||||
If a port is not automatically forwarded, you can forward it manually. For more information, see "[Forwarding a port](/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace#forwarding-a-port)."
|
||||
|
||||
If port forwarding is set up, check the following:
|
||||
|
||||
- Use the notification toast or click the URL in Terminal to open the forwarded port. Typing in `localhost:8000` (as an example) to your local machine will not work if you're connected to the codespace via the browser.
|
||||
- Make sure to check that your application is still running from within your codespace. If your codespace has stopped after a period of inactivity, you'll need to ensure to restart your application once the codespace has restarted.
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
title: Troubleshooting your connection to Codespaces
|
||||
intro: Troubleshooting help for connecting to {% data variables.product.prodname_codespaces %}.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Connection
|
||||
---
|
||||
|
||||
## 503 codespace service unavailable
|
||||
|
||||
Codespaces are set to stop after 30 mintues without any activity. If you try to interact with a codespace after it has stopped, you may see a `503 service unavailable` error.
|
||||
|
||||
- If a **Start** button is shown in {% data variables.product.prodname_vscode %} or in your browser window, click **Start** to reconnect to the codespace.
|
||||
- Reset your codespace by reloading the window. From the [command palette](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces#accessing-the-command-palette) in {% data variables.product.prodname_vscode %}, click **Developer: Reload Window**.
|
||||
|
||||
## Browser cannot connect
|
||||
|
||||
Sometimes you may not be able to access a codespace from your browser. If this happens, go to https://github.com/codespaces and try connecting to the codespace from that page.
|
||||
|
||||
- If the codespace is not listed on that page, check that you are the owner of the codespace you are trying to connect to. You can only open a codespace that you created. The URLs for your codespaces always include your {% data variables.product.company_short %} handle.
|
||||
- If the codespace is listed but you cannot connect from that page, check whether you can connect using a different browser.
|
||||
|
||||
Your company network may be blocking the connection. If possible, check any logging for rejected connections on your device.
|
||||
|
||||
If you still cannot connect, {% data reusables.codespaces.contact-support %}
|
||||
|
||||
## {% data variables.product.prodname_github_codespaces %} extension for {% data variables.product.prodname_vscode %} cannot connect
|
||||
|
||||
If you cannot connect to a codespace from {% data variables.product.prodname_vscode %} desktop, use the following troubleshooting steps.
|
||||
|
||||
1. Check that you have the latest version of the {% data variables.product.prodname_github_codespaces %} extension installed. The extension is a preview release and frequent updates are released.
|
||||
1. In {% data variables.product.prodname_vscode %}, display the "Extensions" tab.
|
||||
2. Select the {% data variables.product.prodname_github_codespaces %} extension to display the extension's overview page.
|
||||
3. If an update is available, a button is shown, click **Update to X.X.X** to upgrade to the latest version.
|
||||
2. Check whether you are using the stable build of {% data variables.product.prodname_vscode %} or the [{% data variables.product.prodname_vscode %} Insiders](https://code.visualstudio.com/insiders/) release (nightly updates). If you are using the insiders release, try installing the [stable build](https://code.visualstudio.com/).
|
||||
3. Your company network may be blocking the connection. If possible, check any logging for rejected connections on your device.
|
||||
|
||||
If you still cannot connect, {% data reusables.codespaces.contact-support %}
|
||||
|
||||
### The codespace has latency issues
|
||||
|
||||
If the codespace seems particularly slow or has latency issues, it is possible that it has been created in a region that is far from you. To resolve this, you can [manually set your {% data variables.product.prodname_github_codespaces %} region](/codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces).
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
title: Working with support for Codespaces
|
||||
intro: Tips on getting the best help from support for {% data variables.product.prodname_codespaces %}.
|
||||
product: '{% data reusables.gated-features.codespaces %}'
|
||||
versions:
|
||||
fpt: '*'
|
||||
type: reference
|
||||
topics:
|
||||
- Codespaces
|
||||
shortTitle: Working with support
|
||||
---
|
||||
|
||||
Before support can help you with problems with codespaces, you need to know the name of the codespace and its codespaces ID (identifier). In addition, support may ask you to share some logs with them. For more information, see "[Codespaces logs](/codespaces/troubleshooting/codespaces-logs)" and "[About GitHub Support](/github/working-with-github-support/about-github-support)."
|
||||
|
||||
### Codespace names
|
||||
|
||||
Each codespace has a unique name that is a combination of your {% data variables.product.company_short %} handle, the repository name, and some random characters. The additional characters allow you to have codespaces for different branches in the same repository. For example: `octocat-myrepo-gmc7`.
|
||||
|
||||
To find the name of a codespace:
|
||||
|
||||
- Open the codespace in the browser. The subdomain of the URL is the name of the codespace. For example: `https://octocat-myrepo-gmc7.github.dev` is the URL for the `octocat-myrepo-gmc7` codespace.
|
||||
- If you cannot open a codespace, you can access the name in {% data variables.product.product_name %} on https://github.com/codespaces. The name is shown in a pop-up when you hover over the **Open in browser** option on https://github.com/codespaces.
|
||||

|
||||
|
||||
The name the codespace is also included in many of the log files. For example, in the codespace logs as the value of `friendlyName`, in the {% data variables.product.prodname_github_codespaces %} extension log after `making GET request for`, and in the browser console log after `clientUrl`. For more information, see "[Codespaces logs](/codespaces/troubleshooting/codespaces-logs)."
|
||||
|
||||
### Codespaces IDs
|
||||
|
||||
Every codespace also has an ID (identifer). This is not shown by default in {% data variables.product.prodname_vscode %} so you may need to update the settings for the {% data variables.product.prodname_github_codespaces %} extension before you can access the ID.
|
||||
|
||||
1. In {% data variables.product.prodname_vscode %}, browser or desktop, in the Activity Bar on the left, click **Remote Explorer** to show details for the codespace.
|
||||
2. If the sidebar includes a "Codespace Performance" section, hover over the "Codespace ID" and click the clipboard icon to copy the ID.
|
||||
3. If the information is not shown, click {% octicon "gear" aria-label="The gear icon" %}, in the bottom-left corner of the Activity Bar, to display the "Settings" tab.
|
||||
4. Expand **Extensions** and click **{% data variables.product.prodname_github_codespaces %}** to display the settings for the extension. Then enable **Show Performance Explorer** to display the "Codespace Performance" section in the sidebar.
|
||||

|
||||
@@ -22,6 +22,6 @@ children:
|
||||
- /addressing-merge-conflicts
|
||||
- /reviewing-changes-in-pull-requests
|
||||
- /incorporating-changes-from-a-pull-request
|
||||
shortTitle: Collaborate with PRs
|
||||
shortTitle: Collaborate with pull requests
|
||||
---
|
||||
|
||||
|
||||
@@ -23,6 +23,8 @@ topics:
|
||||
|
||||
{% endnote %}
|
||||
|
||||
You can create pull requests on {% data variables.product.prodname_dotcom_the_website %}, with {% data variables.product.prodname_desktop %}, in {% data variables.product.prodname_codespaces %}, on {% data variables.product.prodname_mobile %}, and when using GitHub CLI.
|
||||
|
||||
After initializing a pull request, you'll see a review page that shows a high-level overview of the changes between your branch (the compare branch) and the repository's base branch. You can add a summary of the proposed changes, review the changes made by commits, add labels, milestones, and assignees, and @mention individual contributors or teams. For more information, see "[Creating a pull request](/articles/creating-a-pull-request)."
|
||||
|
||||
Once you've created a pull request, you can push commits from your topic branch to add them to your existing pull request. These commits will appear in chronological order within your pull request and the changes will be visible in the "Files changed" tab.
|
||||
|
||||
@@ -151,6 +151,21 @@ gh pr create --web
|
||||
|
||||
{% enddesktop %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
|
||||
{% codespaces %}
|
||||
|
||||
1. Once you've committed changes to your local copy of the repository, click the **Create Pull Request** icon.
|
||||

|
||||
1. Check that the local branch and repository you're merging from, and the remote branch and repository you're merging into, are correct. Then give the pull request a title and a description.
|
||||

|
||||
1. Click **Create**.
|
||||
|
||||
For more information on creating pull requests in {% data variables.product.prodname_codespaces %}, see "[Using Codespaces for pull requests](/codespaces/developing-in-codespaces/using-codespaces-for-pull-requests)."
|
||||
|
||||
{% endcodespaces %}
|
||||
|
||||
{% endif %}
|
||||
## Further reading
|
||||
|
||||
- "[Creating a pull request from a fork](/articles/creating-a-pull-request-from-a-fork)"
|
||||
|
||||
@@ -21,6 +21,10 @@ You can review changes in a pull request one file at a time. While reviewing the
|
||||
|
||||
## Starting a review
|
||||
|
||||
{% include tool-switcher %}
|
||||
|
||||
{% webui %}
|
||||
|
||||
{% data reusables.repositories.sidebar-pr %}
|
||||
{% data reusables.repositories.choose-pr-review %}
|
||||
{% data reusables.repositories.changed-files %}
|
||||
@@ -33,8 +37,21 @@ You can review changes in a pull request one file at a time. While reviewing the
|
||||
Before you submit your review, your line comments are _pending_ and only visible to you. You can edit pending comments anytime before you submit your review. To cancel a pending review, including all of its pending comments, scroll down to the end of the timeline on the Conversation tab, then click **Cancel review**.
|
||||
|
||||

|
||||
{% endwebui %}
|
||||
|
||||
{% ifversion fpt %}
|
||||
|
||||
{% codespaces %}
|
||||
|
||||
You can use [{% data variables.product.prodname_codespaces %}](/codespaces/overview) to test, run, and review pull requests.
|
||||
|
||||
{% data reusables.codespaces.review-pr %}
|
||||
|
||||
For more information on reviewing pull requests in {% data variables.product.prodname_codespaces %}, see "[Using Codespaces for pull requests](/codespaces/developing-in-codespaces/using-codespaces-for-pull-requests)."
|
||||
|
||||
{% endcodespaces %}
|
||||
|
||||
|
||||
## Reviewing dependency changes
|
||||
|
||||
If the pull request contains changes to dependencies you can use the dependency review for a manifest or lock file to see what has changed and check whether the changes introduce security vulnerabilities. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)."
|
||||
|
||||
1
data/reusables/codespaces/availability.md
Normal file
@@ -0,0 +1 @@
|
||||
Codespaces are available for repositories owned by organizations using {% data variables.product.prodname_team %} and {% data variables.product.prodname_ghe_cloud %}.
|
||||
7
data/reusables/codespaces/codespaces-billing.md
Normal file
@@ -0,0 +1,7 @@
|
||||
{% data variables.product.prodname_codespaces %} are billed in US dollars (USD) according to their compute and storage usage.
|
||||
|
||||
### Calculating compute usage
|
||||
The total number of uptime minutes for which the {% data variables.product.prodname_codespaces %} instances are active. Compute usage is calculated by the actual number of minutes used by all codespaces. These totals are reported to the billing service daily, and are billed monthly.
|
||||
|
||||
### Calculating storage usage
|
||||
For {% data variables.product.prodname_codespaces %} billing purposes, this includes all storage used by all codespaces in your account. This includes any files used by the codespaces, such as cloned repositories, configuration files, and extensions, among others. These totals are reported to the billing service daily, and are billed monthly. At the end of the month, {% data variables.product.prodname_dotcom %} rounds your storage to the nearest MB.
|
||||
@@ -1,13 +1 @@
|
||||
You can run your codespace on a choice of three types of remote machine: Basic, Standard, or Premium. Each of these has a different level of resources and a different billing tier. <!-- For information, see "[About billing for Codespaces](/github/developing-online-with-codespaces/about-billing-for-codespaces)." -->
|
||||
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data reusables.codespaces.about-billing-for-codespaces %}
|
||||
|
||||
{% endnote %}
|
||||
|
||||
Switching machine types gives you the flexibility to choose the most appropriate resources for your work. Certain tasks may require different machine types:
|
||||
|
||||
* **Basic** for updating a file and raising a pull request
|
||||
* **Standard** for editing a website
|
||||
* **Premium** for high compute tasks such as data analysis
|
||||
You can run your codespace on a choice of remote machine, from 2 cores to 32 cores. Each of these has a different level of resources and a different billing tier. For information, see "[About billing for Codespaces](/github/developing-online-with-codespaces/about-billing-for-codespaces)."
|
||||
|
||||
@@ -0,0 +1,7 @@
|
||||
{% note %}
|
||||
|
||||
**Note:** After the {% data variables.product.prodname_codespaces %} trial period ends, you must set a spending limit before you can use {% data variables.product.prodname_codespaces %}. By default, your organization will have a {% data variables.product.prodname_codespaces %} spending limit of $0, which prevents any codespaces from being created. To allow your users to create codespaces in your organization, set the limit to a value higher than $0.
|
||||
|
||||
{% endnote %}
|
||||
|
||||
By default, your organization will have a {% data variables.product.prodname_codespaces %} spending limit of $0, which prevents new codespaces from being created or existing codespaces from being opened. To allow your users to create codespaces in your organization, set the limit to a value higher than $0.
|
||||
5
data/reusables/codespaces/codespaces-trial-period.md
Normal file
@@ -0,0 +1,5 @@
|
||||
{% note %}
|
||||
|
||||
**Note:** {% data variables.product.prodname_codespaces %} is free to use for all organizations on a {% data variables.product.prodname_team %} or {% data variables.product.prodname_ghe_cloud %} plan until September 10, 2021. After this trial period ends, you must set a spending limit to continue to use Codespaces. For more information, see "[Managing spending limits for Codespaces](/billing/managing-billing-for-github-codespaces/managing-spending-limits-for-codespaces)."
|
||||
|
||||
{% endnote %}
|
||||