关于为仓库创建 Codespace
您可以在 GitHub、Visual Studio Code 或使用 GitHub CLI 创建 Codespace。使用本文中的选项卡显示创建 Codespace 的每种方法的说明。
您可以在您的个人 GitHub 帐户上使用 GitHub Codespaces,免费版和专业版帐户每月包含免费使用配额。您可以通过提供付款信息并设置支出限额来继续使用超过每月包含的存储和计算用量的 GitHub Codespaces。请参阅“关于 GitHub Codespaces 的计费”。
组织可以允许成员和外部协作者创建和使用 Codespaces,费用由组织承担。有关详细信息,请参阅“选择谁拥有和支付组织中的 Codespaces”。
您从组织拥有的仓库创建 Codespaces 的能力取决于几个因素,包括仓库的可见性和组织或其父级企业的设置。有关详细信息,请参阅“Codespaces 创建和删除故障排除”。
如果您正在启动一个新项目,您可能希望从模板创建 Codespace,然后稍后发布到 GitHub 上的仓库。有关详细信息,请参阅“从模板创建 Codespace”。
注意
如果您使用 JetBrains IDE,您可以使用 GitHub CLI 创建 Codespace。然后,您可以使用 JetBrains Gateway 应用程序在 JetBrains IDE 中打开 Codespace。有关详细信息,请参阅“在 JetBrains IDE 中使用 GitHub Codespaces”。
如果从仓库创建 Codespace,则 Codespace 将与特定分支关联,该分支不能为空。您可以为每个仓库甚至每个分支创建多个 Codespace。
您可以在“您的 Codespaces”页面上查看您创建的所有可用 Codespace。要显示此页面,请在 GitHub 的左上角选择,然后单击 Codespaces。这将带您到 github.com/codespaces。
Codespace 创建过程
创建 Codespace 时,会执行多个步骤来创建开发环境并将其连接到您。
- 步骤 1:将虚拟机和存储分配给您的 Codespace。
- 步骤 2:创建容器并克隆您的仓库。
- 步骤 3:您可以连接到 Codespace。
- 步骤 4:Codespace 继续进行创建后的设置。
有关创建 Codespace 时发生情况的更多信息,请参阅“深入了解 GitHub Codespaces”。
有关 Codespace 生命周期更多信息,请参阅“了解 Codespace 生命周期”。
如果您想在 Codespace 中使用 Git 钩子,则应使用devcontainer.json
生命周期脚本(例如postCreateCommand
)设置钩子。这些脚本在上一步 4 中执行。有关生命周期脚本的信息,请参阅开发容器网站上的开发容器规范。由于您的 Codespace 的开发容器是在克隆仓库后创建的,因此在开发容器镜像中配置的任何git 模板目录都不会应用于您的 Codespace。钩子必须在创建 Codespace 后安装。
您可以在使用 VS Code 进行开发时编辑代码、调试和使用 Git 命令。有关更多信息,请参阅VS Code 文档。
为了加快 Codespace 创建速度,仓库管理员可以为仓库启用 GitHub Codespaces 预构建。有关更多信息,请参阅“关于 GitHub Codespaces 预构建”。
为仓库创建 Codespace
-
在 GitHub 上,导航到仓库的主页。
-
在仓库名称下,选择分支下拉菜单(标有当前分支的名称),然后单击要为其创建 Codespace 的分支。
-
单击 代码按钮,然后单击Codespaces选项卡。
对话框底部会显示一条消息,告知您谁将为 Codespace 付费。
-
创建您的 Codespace,可以使用默认选项,也可以在配置高级选项后创建。
-
使用默认选项
要使用默认选项创建 Codespace,请单击.
-
配置高级选项
要配置 Codespace 的高级选项,例如不同的机器类型或特定的
devcontainer.json
文件-
在Codespaces选项卡的右上角,选择并单击使用选项新建。
-
在 Codespace 的选项页面上,从下拉菜单中选择您首选的选项。
选项页面也可能会显示一个或多个建议您在 Codespaces 设置中创建的密钥的名称。有关更多信息,请参阅“推荐的密钥”。
注意
- 您可以将选项页面添加为书签,以便快速创建此仓库和分支的 Codespace。
- https://github.com/codespaces/new页面提供了一种快速创建任何仓库和分支的 Codespace 的方法。您可以通过在浏览器的地址栏中键入
codespace.new
快速访问此页面。 - 有关开发容器配置文件的更多信息,请参阅“开发容器简介”。
- 有关机器类型的更多信息,请参阅“更改 Codespace 的机器类型”。
- 您可用的机器类型选择可能会受到多种因素的限制。这些因素可能包括为您的组织配置的策略,或仓库的最小机器类型规范。有关更多信息,请参阅“限制对机器类型的访问”和“设置 Codespace 机器最小规格”。
-
单击创建 Codespace。
-
-
推荐的密钥
在创建 Codespace 时,高级选项页面上可能会显示用户定义密钥的名称。如果您选择了推荐密钥,则会在您选择的开发容器配置中显示。有关更多信息,请参阅“指定仓库的推荐密钥”。
建议您在系统提示您这样做时输入这些开发环境密钥的值,因为您的项目很可能需要这些密钥的值。但是,您无需提供值即可创建 Codespace。如果您愿意,可以在 Codespace 中设置这些密钥。
如果您输入推荐密钥的值,则该密钥将在新的 Codespace 中可用。当您单击创建 Codespace时,该密钥也会添加到您针对 Codespaces 的个人设置中,因此在您将来为该仓库创建 Codespace 时,您无需再次输入该密钥的值。
如果密钥名称显示为一个不可选择的复选框,并且没有输入框,则表示您已经在针对 Codespaces 的个人设置中配置了此名称的密钥,并且您已将其与该仓库关联。如果您创建了此名称的密钥但未将其与该仓库关联,则可以选择该复选框,通过这样做,您可以更新设置以添加关联。
如果您想更改预选密钥的值,可以从针对 Codespaces 的个人设置中进行更改,网址为 github.com/settings/codespaces。有关更多信息,请参阅“管理您针对 GitHub Codespaces 的帐户特定密钥”。
将您的 GitHub 帐户连接到 GitHub Codespaces 扩展后,您可以创建一个新的 Codespace。有关 GitHub Codespaces 扩展的更多信息,请参阅VS Code 市场。
-
在 VS Code 中,在活动栏中,单击远程资源管理器图标。
注意
如果活动栏中未显示远程资源管理器
- 访问命令面板。例如,按Shift+Command+P(Mac)/Ctrl+Shift+P(Windows/Linux)。
- 键入:
details
。 - 单击Codespaces:详细信息。
-
将鼠标悬停在“远程资源管理器”侧边栏上并单击.
-
在文本框中,键入您要在其内进行开发的仓库的名称,然后选择它。
后续提示的右侧会显示一条消息,告知您谁将为 Codespace 付费。
-
单击您要开发的分支。
-
如果提示您选择开发容器配置文件,请从列表中选择一个文件。
-
单击您要使用的机器类型。
注意
您可用的机器类型选择可能会受到多种因素的限制。这些因素可能包括为您的组织配置的策略,或仓库的最小机器类型规范。有关更多信息,请参阅“限制对机器类型的访问”和“设置 Codespace 机器最小规格”。
要了解有关 GitHub CLI 的更多信息,请参阅“关于 GitHub CLI”。
要创建新的 Codespace,请使用gh codespace create
子命令。
gh codespace create
系统会提示您选择一个仓库。将显示一条消息,告知您谁将为 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
替换为可用机器类型的有效标识符。标识符是字符串,例如:basicLinux32gb
和standardLinux32gb
。可用的机器类型取决于仓库、您的个人帐户和您的位置。如果您输入无效或不可用的机器类型,则错误消息中会显示可用的类型。如果您省略此标志并且有多个机器类型可用,则系统会提示您从列表中选择一个。
有关此命令选项的完整详细信息,请参阅GitHub CLI 手册。