从模板创建 Codespace

关于 GitHub Codespaces 的模板

如果您要启动一个新项目，您可以通过从模板创建 Codespace，快速开始开发工作。您将能够在基于云的开发环境中处理您的项目，将您的文件保存在云中，并将您的工作发布到新的远程存储库中，您可以与他人共享或克隆到您的本地计算机。

您可以从空白模板开始，从 GitHub 为流行技术（如 React 或 Jupyter Notebook）维护的模板中进行选择，或从 GitHub 上的任何模板存储库启动 Codespace。

使用空白模板，您将从一个空目录开始，可以访问基于云的计算资源以及默认开发容器映像预先安装的工具、语言和运行时环境。使用其他模板，您将获得正在使用的技术的入门文件，以及一些额外文件，例如自述文件、.gitignore 文件和包含一些自定义环境配置的开发容器配置文件。有关开发容器和默认映像的更多信息，请参阅“开发容器简介”。

例如，如果您从 GitHub 的 React 模板创建代码空间，您将进入一个包含简单应用程序模板文件的工作区，例如 index.js、app.js 和 package.json。在代码空间打开后不久，开发服务器将自动启动，您将能够在 VS Code Web 客户端中的一个简单浏览器选项卡中查看正在运行的应用程序。

模板中包含的文件和配置在模板存储库中定义。当您创建代码空间时，模板存储库将克隆到您的代码空间中。之后，链接将断开，您的代码空间将不会链接到远程存储库，直到您发布到远程存储库。

从 GitHub 模板创建代码空间

GitHub 维护的模板（包括空白模板）可在“您的代码空间”页面中找到。

1. 在 GitHub.com 的左上角，选择 ，然后单击 代码空间，将您带到 github.com/codespaces 上的“您的代码空间”页面。

2. 要查看模板的完整列表，请在“探索快速入门模板”部分中，单击查看全部。

   

3. 或者，要查看包含模板文件的模板存储库，请单击模板的名称。

   

4. 在您想要启动的模板名称下，单击使用此模板。

当您从模板创建新的代码空间时，它始终在 Visual Studio Code Web 客户端中打开。您可以在任何受支持的编辑器中重新打开现有的代码空间。有关更多信息，请参阅“打开现有的代码空间”。

从模板存储库创建 Codespace

你可以从任何模板存储库创建 Codespace，然后在你准备就绪时将你的工作发布到新存储库。有关模板存储库的更多信息，请参阅“从模板创建存储库”。

1. 在 GitHub.com 上，导航到存储库的主页。

2. 单击“使用此模板”，然后单击“在 Codespace 中打开”。

   

   注意：如果你模板存储库的维护者，并希望提交更改到模板存储库本身，你应该从 代码下拉列表中创建 Codespace。有关更多信息，请参阅“为存储库创建 Codespace”。

当您从模板创建新的代码空间时，它始终在 Visual Studio Code Web 客户端中打开。您可以在任何受支持的编辑器中重新打开现有的代码空间。有关更多信息，请参阅“打开现有的代码空间”。

发布到 GitHub 上的存储库

当你使用从模板创建的 Codespace 工作时，你的工作将保存在云中的虚拟机上，但不会存储在 GitHub 上的存储库中。

你可以保存文件、关闭并停止 Codespace，然后稍后回来继续工作。通常，Git 会预先安装，并且工作目录将自动初始化为 Git 存储库，除非你从 GitHub 的空白模板开始。这意味着你可以立即将 Git 用于本地源代码控制，例如添加和提交文件。

但是，如果你删除未发布的 Codespace，或者如果它在保留期内未被使用而被自动删除，那么你的工作也将被删除。要保留你的工作，并允许其他人参与你的项目，你需要将你的 Codespace 发布到 GitHub 上的存储库。

在 VS Code 中发布

如果你正在代码空间中工作，你可以从 VS Code Web 客户端或桌面应用程序中发布它。

1. 在活动栏中，单击源代码管理视图。

   

2. 要暂存你的更改，请单击已添加或更改的文件旁边的+，或如果你已更改多个文件并希望暂存所有文件，请单击更改旁边的+。

   

   注意：如果你从 GitHub 的空白模板开始，则除非你已将目录初始化为 Git 存储库，否则你将看不到更改列表。要发布从空白模板创建的代码空间，请在“源代码管理”视图中单击发布到 GitHub，然后跳到步骤 5。

3. 要提交暂存的更改，请键入描述你所做更改的提交消息，然后单击提交。

   

4. 单击发布分支。

   

5. 在“存储库名称”下拉列表中，为你的新存储库键入一个名称，然后选择发布到 GitHub 私有存储库或发布到 GitHub 公共存储库。

   

   新存储库的所有者将是你用于创建代码空间的 GitHub 帐户。

6. 或者，在编辑器右下角出现的弹出窗口中，单击在 GitHub 上打开以在 GitHub.com 上查看新存储库。

   

当代码空间发布后，你可以访问更多选项来定制你的 GitHub Codespaces 体验。例如，你可以

• 更改代码空间的机器类型，以确保你使用与所做工作相匹配的资源（请参阅“更改代码空间的机器类型”）。
• 允许 GitHub 自动使用 GPG 签名你在代码空间中进行的提交（请参阅“管理 GitHub Codespaces 的 GPG 验证”）。
• 与你的代码空间共享机密（请参阅“管理 GitHub Codespaces 的帐户特定机密”）。

在 GitHub.com 上发布

您可以在 GitHub.com 上的“您的代码空间”页面上发布未发布的代码空间。如果您想发布当前在浏览器中未打开的代码空间，这将非常有用。如果您这样做，您的工作将保存在存储库中，但您的现有代码空间和新存储库之间不会有链接。但是，您可以导航到新存储库并从中创建一个代码空间，此代码空间将连接到该存储库。

1. 在 GitHub.com 的左上角，选择 ，然后单击 代码空间，将您带到 github.com/codespaces 上的“您的代码空间”页面。

2. 在未发布的代码空间旁边，单击省略号 (...)，然后选择发布到新存储库。

   

3. 为您的新存储库选择一个名称，将其设置为公开或私有，然后单击创建存储库。

   

4. 或者，要查看新存储库，请单击查看存储库。

延伸阅读

• "为存储库创建代码空间"
• "了解代码空间生命周期"
• "在您的代码空间中使用源代码管理"