配置预生成

可以为存储库的特定分支与特定开发容器配置文件的组合设置预生成配置。

从启用预生成的父分支创建的所有分支通常也会获得同一开发容器配置的预生成。这是因为使用父分支所用开发容器配置的子分支的预生成在大多数情况下是相同的，因此可以帮助开发人员从这些分支更快地创建 codespace。请参阅“开发容器简介”。

通常，如果为分支配置预生成，预生成可用于多种计算机类型。但是，如果存储库大于 32 GB，预生成就不适用于 2 核和 4 核计算机类型，因为这些计算机类型提供的存储限制为 32 GB。

先决条件

预生成是使用 GitHub Actions 创建的。因此，必须在要为其配置预生成的存储库中启用 GitHub Actions。请参阅“管理存储库的 GitHub Actions 设置”。

可以在个人帐户拥有的任何存储库中设置预生成。预生成将占用存储空间，这会产生可计费费用，或对于个人帐户拥有的存储库，这将使用每月包含的存储空间的一部分。

Note

如果为分支存储库创建预生成，则这些预生成的存储成本将从每月包含的存储中减去（如有）。如果已使用完所有包含的存储，并且已设置计费，则会对个人帐户进行收费。即使为分支创建的 codespace 是由拥有父存储库的组织支付，也是如此。请参阅“关于 GitHub Codespaces 的计费”。

对于组织拥有的存储库，如果组织已加入 GitHub Team 或 GitHub Enterprise 计划，则可以设置预生成。此外，必须在组织帐户或其父企业上添加付款方式并为 GitHub Codespaces 设置支出限制。请参阅“管理 GitHub Codespaces 的支出限制”和“GitHub 的计划”。

配置预生成

在 GitHub 上，导航到存储库的主页面。
在存储库名称下，单击 “设置”。如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。
在边栏的“代码和自动化”部分，单击“ Codespaces”。
在页面的“预生成配置”部分，单击“设置预生成”。
选择要为其设置预生成的分支。

Note

从启用预生成的基础映像分支创建的所有分支通常也会获得同一开发容器配置的预生成。例如，如果在存储库的默认分支上为开发容器配置文件启用预生成，则大多数情况下，基于默认分支的分支也会获得同一开发容器配置的预生成。
根据需要，可以在显示的“配置文件”下拉菜单中选择要用于预生成的 devcontainer.json 配置文件。请参阅“开发容器简介”。
选择要如何自动触发预生成更新。
- 每次推送（默认设置）- 通过此设置，预生成将在每次对给定分支进行推送时更新。这可确保从预生成生成的 codespace 始终包含最新的 codespace 配置，包括任何最近添加或更新的依赖项。
- 配置更改时 - 借助此设置，更改以下任何文件时都会更新预生成：
  - .devcontainer/devcontainer.json
    
    Note
    
    .devcontainer 的子目录中的 devcontainer.json 文件更改不会触发预生成更新。
  - .devcontainer/devcontainer.json 文件的 build.dockerfile 属性中引用的 Dockerfile。
  此设置可确保在从预生成生成 codespace 时使用对存储库的开发容器配置文件进行的更改。更新预生成的 GitHub Actions 工作流的运行频率较低，因此此选项使用的 GitHub Actions 分钟数较少。但是，此选项不保证 codespace 始终包含最近添加或更新的依赖项，因此在创建 codespace 后可能需要手动添加或更新这些依赖项。
- 计划 - 使用此设置，可以根据你定义的自定义计划更新预生成。这可以减少 GitHub Actions 分钟数消耗，但是，使用此选项，可以创建 codespace，而不使用最新的开发容器配置更改。
根据需要，可以选择“减少仅对特定区域可用的预生成”，以便仅在指定区域中创建预生成。选择要在其中提供预生成的区域。

默认情况下，预生成在所有可用区域中创建，每个预生成都会产生存储费用。
Note
- 每个区域的预生成会产生单独的存储费用。因此，应只为已知将使用的区域启用预生成。请参阅“关于 GitHub Codespaces 的计费”。
- 开发人员可以为 GitHub Codespaces 设置其默认区域，这样就可以减少要启用预生成的区域。请参阅“设置 GitHub Codespaces 的默认区域”。
根据需要，可以在“模板历史记录”下设置要保留的预生成模板版本数。可以输入介于 1 和 5 之间的任意数字。默认保存的版本数为 2，这意味着只保存最新版本的和上一个版本的预生成。

根据预生成触发器设置，预生成可能会随每个推送或每个开发容器配置的更改而更改。保留较旧版本的预生成使你能够使用与当前预生成不同的开发容器配置从较旧的提交创建预生成。通过此设置可将保留的版本数设置为所需的级别。

如果将保存的预生成版本数设置为 1，GitHub Codespaces 将仅保存最新版本的预生成，并在每次模板更新时删除旧版本。这意味着，如果返回到较旧的开发容器配置，则不会获取预生成的 codespace。

保留的每个预生成版本都需支付存储费用。例如，如果要在 4 个区域中生成预生成并保留 2 个版本，则最多需要支付 8 个预生成的存储费用。请参阅“关于 GitHub Codespaces 的计费”。
根据需要，可以添加用户或团队，以便在此配置的预生成工作流运行失败时发出通知。可以开始键入用户名、团队名称或全名，然后在显示名称后单击该名称以将其添加到列表中。发生预生成失败时，添加的用户或团队将收到电子邮件，其中包含工作流运行日志链接，以帮助进一步调查。

Note

如果用户在其个人设置中启用了针对失败的 Actions 工作流的通知，则仅会收到关于预生成失败的通知。请参阅“配置通知”。
根据需要，单击页面底部的“显示高级选项”。

在“高级选项”部分中，如果选择“禁用预生成优化”，则当最新的预生成工作流失败或当前正在运行时，将在没有预生成的情况下创建 codespace。请参阅“对预生成进行故障排除”。
单击“创建”。

如果存储库的开发容器配置指定了访问其他存储库的权限，你将看到一个授权页面。有关 devcontainer.json 文件中如何指定此内容的详细信息，请参阅“管理对代码空间中其他存储库的访问权限”。

单击查看请求权限的详细信息。

单击“授权并继续”，授予这些权限来创建预生成。另外，可以单击“在未经授权的情况下继续”，但如果这样做，从生成的预生成创建的 codespace 可能无法正常工作。

Note

使用此预生成创建 Codespaces 的用户也需要授予这些权限。