[MERGE 8/11 @ 8:45am PT] Codespaces Megabranch (#20378)
Adding Codespaces docs
This commit is contained in:
Amy Burns
@@ -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**.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user