Skip to main content

为存储库创建 codespace

您可以为仓库中的分支创建代码空间以便在线开发。

关于为存储库创建 codespace

可以在 GitHub.com 上、Visual Studio Code 中或使用 GitHub CLI 创建代码空间。使用本文中的选项卡显示有关创建 codespace 的每种方法的说明。

如果要启动新项目,建议通过模板创建 codespace 并稍后将其发布到 GitHub 上的存储库。有关详细信息,请参阅“通过模板创建 codespace”。

注意:如果使用 JetBrains IDE,则可以使用 GitHub CLI 创建 codespace。 然后,你就可以使用 JetBrains Gateway 应用程序在 JetBrains IDE 中打开 codespace。 有关详细信息,请参阅“在 JetBrains IDE 中使用 Codespaces”。

可以在个人 GitHub.com 帐户上使用 GitHub Codespaces,其中免费版和专业版计划中的帐户包含每月免费使用配额。 通过提供付款详细信息和设置支出限制,可以在超出每月包含的存储空间和计算使用量后继续使用 GitHub Codespaces。 有关详细信息,请参阅“关于 GitHub Codespaces 的计费”。

组织可以让成员和外部协作者能够创建和使用 codespace,费用由组织承担。 有关详细信息,请参阅“为组织启用 GitHub Codespaces”。

您创建的每个代码空间只有您才可以使用。 其他任何人都不能在您的代码空间中工作。

如果从存储库创建 codespace,该 codespace 将与不能为空的特定分支相关联。 每个仓库甚至每个分支可创建多个代码空间。

可以在 github.com/codespaces 上查看你创建的每个可用代码空间。

codespace 创建过程

创建代码空间时,需要执行一些步骤并将您连接到开发环境。

  • 第 1 步:虚拟机和存储被分配到您的代码空间。
  • 第 2 步:创建容器并克隆仓库。
  • 第 3 步:您可以连接到代码空间。
  • 第 4 步:代码空间继续创建后设置。

有关创建 codespace 时发生的情况的详细信息,请参阅“深入探讨。”

有关 codespace 生命周期的详细信息,请参阅“codespace 生命周期”。

如果要对 codespace 使用 Git 挂钩,则应在步骤 4 中使用 devcontainer.json 生命周期脚本(如 postCreateCommand)设置挂钩。 由于在克隆存储库之后创建了 codespace 容器,因此在容器映像中配置的任何 git 模板目录将不适用于你的 codespace。 在创建代码空间后,必须改为安装挂钩。 有关使用 postCreateCommand 的详细信息,请参阅 VS Code 文档中的 devcontainer.json 参考

使用 VS Code 在 codespace 中开发时,你可以编辑代码、调试和使用 Git 命令。 有关详细信息,请参阅 VS Code 文档

To speed up codespace creation, repository administrators can enable GitHub Codespaces prebuilds for a repository. For more information, see "About GitHub Codespaces prebuilds."

为存储库创建 codespace

  1. On GitHub.com, navigate to the main page of the repository.

  2. 在存储库名称下,使用“分支”下拉菜单,然后选择要为其创建 codespace 的分支。

    “分支”下拉菜单

  3. 单击“ 代码”按钮,然后单击“codespace”选项卡。

    新建代码空间按钮

    如果此存储库的 codespace 的计费对象为组织或其父企业,则会在“在 BRANCH 上创建 codespace”按钮下方显示一条消息,告知谁将为 codespace 付费。

  4. 使用默认选项或在配置高级选项之后创建 codespace:

    • 使用默认选项

      要使用默认选项创建 codespace,请单击“加号 ()”。 如果当前没有此存储库的任何 codespace,也可以单击“在 BRANCH 上创建 codespace”。

    • 配置选项

      若要配置 codespace 高级选项(例如其他计算机类型或特定 devcontainer.json 文件),请执行以下操作:

      1. 单击“Codespaces”选项卡右上角的省略号 (…),然后单击“使用选项新建” 。

        查看默认计算机类型

      2. 在 codespace 选项页上,从下拉菜单中选择首选选项。

        codespace 选项页

        说明

      3. 单击“创建 codespace”。

将 GitHub.com 上的帐户连接到 GitHub Codespaces 扩展后,可以创建新的 codespace。 有关 GitHub Codespaces 扩展的详细信息,请参阅 VS Code Marketplace

  1. 在 VS Code 中,从左侧边栏单击“远程 Explorer”图标。

    Visual Studio Code 中的 Remote Explorer 图标

    Note: If the Remote Explorer is not displayed in the Activity Bar:

    1. Access the Command Palette. For example, by pressing Shift+Command+P (Mac) / Ctrl+Shift+P (Windows/Linux).
    2. Type: codespaces.
    3. Click Codespaces: Details.
  2. 单击“添加”图标:

    GitHub Codespaces 中的“新建 Codespace”选项

  3. 键入要在其中开发的存储库的名称,然后将其选中。

    搜索要在其中新建 codespace 的存储库

    如果你选择的存储库归组织所有,并且该组织已将此存储库的 codespace 配置为可向组织或其父企业计费,则后续提示中会显示一条消息,告知谁将支付 codespace 费用。

  4. 单击要在其中开发的分支。

    搜索要在其中新建 codespace 的分支

  5. 如果系统提示选择开发容器配置文件,请从列表中选择一个文件。

    为 GitHub Codespaces 选择一个开发容器配置文件

  6. 选择你要使用的机器类型。

    新 codespace 的实例类型

    注意:你选择的可用计算机类型可能会受到多种因素的限制。 其中可能包括为组织配置的策略,或者存储库的计算机类型最低规范。 有关详细信息,请参阅“限制对计算机类型的访问”和“为代码空间计算机设置最低规范”。

若要详细了解 GitHub CLI,请参阅“关于 GitHub CLI”。

若要创建新的 codespace,请使用 gh codespace create 子命令。

gh codespace create 

系统会提示你选择存储库。 如果此存储库的 codespace 的计费对象为组织或其父企业,则会显示一条消息,告知谁将为 codespace 付费。 系统将提示你选择分支、开发容器配置文件(如果有多个可用)和计算机类型(如果有多个可用)。

或者,您可以使用标志来指定部分或全部选项:

gh codespace create -r OWNER/REPO -b BRANCH --devcontainer-path PATH -m MACHINE-TYPE

在此示例中,将 owner/repo 替换为存储库标识符。 将 branch 替换为你希望最初在 codespace 中签出的分支的名称或提交的完整 SHA 哈希。 如果使用 -r 标志而不使用 b 标志,则从默认分支创建 codespace。

path 替换为要用于新的 codespace 的开发容器配置文件的路径。 如果省略此标志,并且有多个开发容器文件可用,系统将提示你从列表中选择一个文件。 有关开发容器配置文件的详细信息,请参阅“开发容器简介”。

machine-type 替换为可用计算机类型的有效标识符。 标识符是字符串,例如:basicLinux32gbstandardLinux32gb。 可用的计算机类型取决于存储库、个人帐户以及你的位置。 如果输入无效或不可用的计算机类型,则错误消息中将显示可用类型。 如果省略此标志,并且有多个计算机类型可用,系统将提示您从列表中选择一个计算机类型。

有关此命令的选项的完整详细信息,请参阅 GitHub CLI 手册

延伸阅读