Skip to main content

GitHub Codespaces 概述

本指南介绍了 GitHub Codespaces,并详细介绍了它的工作原理和使用方法。

什么是代码空间?

代码空间是托管在云中的开发环境。 可通过将配置文件提交到存储库(通常称为“配置即代码”)来为 GitHub Codespaces 自定义项目,这将为项目的所有用户创建可重复的 codespace 配置。

每个 codespace 都在由 GitHub 托管的虚拟机上运行。 可以根据需要的资源选择要使用的计算机类型。 有各种类型的计算机可供选择,从 2 核处理器、4 GB RAM 和 32 GB 存储开始。

可以从浏览器、Visual Studio Code、JetBrains Gateway 应用程序或使用 GitHub CLI 连接到 codespaces。

显示 GitHub Codespaces 工作原理的示意图

使用 GitHub Codespaces

要开始使用基于云的计算资源进行开发,可以通过模板或存储库中的任何分支或提交创建 codespace。 通过模板创建 codespace 时,可以从空白模板开始,也可以选择适合你正在做的工作的模板。

要开始使用 GitHub Codespaces,请参阅“GitHub Codespaces 快速入门”。 有关创建 codespace 的详细信息,请参阅“为存储库创建 codespace”或“通过模板创建 codespace”。 如果要返回到已创建的 codespace,请参阅“打开现有 codespace”。 要详细了解 GitHub Codespaces 的工作原理,请参阅“深入了解 GitHub Codespaces”。

使用个人帐户拥有的 codespaces

所有个人 GitHub.com 帐户都有免费或专业版计划中包含的 GitHub Codespaces 的每月免费使用配额。 无需更改任何设置或提供付款详细信息,即可在个人帐户上开始使用 GitHub Codespaces。

可为可以克隆的任何存储库创建和使用 codespace。 还可以使用模板来创建最初不与存储库关联的 codespaces。 如果通过组织拥有的存储库创建 codespace,则 codespace 的使用按照组织(如果组织对此进行了配置)或个人帐户进行计费。 通过模板创建的 codespaces 始终按照个人帐户进行计费。

通过提供付款详细信息和设置支出限制,可以在超出每月包含的存储空间和计算使用量后继续使用 GitHub Codespaces。 有关详细信息,请参阅“关于 GitHub Codespaces 的计费”。

使用组织拥有的 codespaces

组织所有者可以启用 GitHub Codespaces,后者可按照组织或企业帐户计费。 这适用于通过组织拥有的存储库创建的 codespaces。 有关详细信息,请参阅“为组织启用 GitHub Codespaces”。 可以对组织或企业帐户上的 GitHub Codespaces 使用设置支出限制。 有关详细信息,请参阅“管理 GitHub Codespaces 的支出限制”。

如果按照组织或企业对 codespace 的使用进行计费,则会在创建 codespace 时显示。 有关详细信息,请参阅“为存储库创建 codespace”。 按照组织或其父企业计费的 codespace 归组织所有,且可被组织所有者删除。 有关详细信息,请参阅“删除 codespace”。

自定义 GitHub Codespaces

若要自定义 codespace 中的运行时和工具,可以为存储库创建一个或多个开发容器配置。 将开发容器配置添加到存储库后,可以定义适合用户将在存储库中执行的工作的不同开发环境选择。

如果通过没有任何开发容器配置的存储库创建 codespace,GitHub Codespaces 会将存储库克隆到具有默认 codespace 映像的环境中,该映像包含许多工具、语言和运行时环境。 如果通过模板创建 codespace,则可以从默认映像之上的一些初始配置开始。 有关详细信息,请参阅“开发容器简介”。

可使用公共点文件存储库对 codespace 环境的各个方面进行个性化设置。 可使用点文件设置 shell 别名和首选项,也可安装喜欢使用的工具的个人首选项。 如果在浏览器或 Visual Studio Code 中使用 GitHub Codespaces,则可以使用设置同步为 codespace 编辑器提供在本地安装 Visual Studio Code 中设置的相同设置、键盘快捷方式、片段和扩展。

有关详细信息,请参阅“自定义代码空间”。

Codespaces 的计费

有关 GitHub Codespaces 的定价、存储和使用情况的信息,请参阅“有关 GitHub Codespaces 的计费”。

注意:必须为个人、组织或企业帐户设置非零支出限制,然后才能向帐户对 GitHub Codespaces 的使用进行计费。

默认情况下,所有帐户的 GitHub Codespaces 支出限制为 0 美元。 这可以防止创建新的 codespace 或打开现有 codespace,如果执行这些操作,将对个人、组织或企业帐户产生可计费成本。 对于个人帐户,如果帐户尚未达到其每月包含的使用量限制,则始终可以创建和使用 codespace。 对于组织和企业,默认支出限制意味着,要允许用户创建向组织或其父企业计费的 codespace,必须将限制更改为高于 0 美元的值。

Costs for GitHub Codespaces are always billed monthly, even if your account is otherwise billed annually. 有关组织所有者和计费管理员如何管理组织的 GitHub Codespaces 的支出限制的信息,请参阅“管理 GitHub Codespaces 的支出限制”。