{"meta":{"title":"配置预生成","intro":"可以配置你的项目，使其在你每次将更改推送到存储库时，自动预先构建 codespace。","product":"Codespaces","breadcrumbs":[{"href":"/zh/enterprise-cloud@latest/codespaces","title":"Codespaces"},{"href":"/zh/enterprise-cloud@latest/codespaces/prebuilding-your-codespaces","title":"预生成 codespaces"},{"href":"/zh/enterprise-cloud@latest/codespaces/prebuilding-your-codespaces/configuring-prebuilds","title":"配置预构建"}],"documentType":"article"},"body":"# 配置预生成\n\n可以配置你的项目，使其在你每次将更改推送到存储库时，自动预先构建 codespace。\n\n可以为存储库的特定分支与特定开发容器配置文件的组合设置预生成配置。\n\n从启用预生成的父分支创建的所有分支通常也会获得同一开发容器配置的预生成。 这是因为使用相同开发容器配置的子分支与父分支的预构建在大多数情况下大体相同，因此开发人员也可以从这些分支中受益，享受更快的代码空间创建时间。 请参阅“[开发容器简介](/zh/enterprise-cloud@latest/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)”。\n\n通常，如果为分支配置预生成，预生成可用于多种计算机类型。 但是，如果存储库大于 32 GB，预生成就不适用于 2 核和 4 核计算机类型，因为这些计算机类型提供的存储限制为 32 GB。\n\n## 先决条件\n\n预生成是使用 GitHub Actions. 因此， GitHub Actions 必须为要为其配置预构建的存储库启用。 请参阅“[管理存储库的GitHub Actions设置](/zh/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository)”。\n\n可以在个人帐户拥有的任何存储库中设置预生成。 预生成过程将占用存储空间，这将产生计费费用；对于个人帐户拥有的存储库，则会占用每月包含的存储空间的一部分。\n\n> \\[!NOTE]\n> 如果为分支存储库创建预生成，则这些预生成的存储成本将从每月包含的存储中减去（如有）。 如果已使用完所有包含的存储，并且已设置计费，则会对个人帐户进行收费。 即使为分支创建的 codespace 是由拥有父存储库的组织支付，也是如此。 请参阅 [GitHub Codespaces 计费](/zh/enterprise-cloud@latest/billing/concepts/product-billing/github-codespaces#how-costs-are-assigned-to-a-billable-account)。\n\n对于组织拥有的存储库，如果组织处于 GitHub Team 或 GitHub Enterprise 计划中，则可以设置预生成。 此外，还必须添加付款方式，并为组织帐户或其父企业设置支出限制 GitHub Codespaces 。 请参阅“[设置预算以控制按流量计费的产品的支出](/zh/enterprise-cloud@latest/billing/how-tos/set-up-budgets#managing-budgets-for-your-organization-or-enterprise)”和“[GitHub的计划](/zh/enterprise-cloud@latest/get-started/learning-about-github/githubs-plans)”。\n\n## 配置预生成\n\n1. 在 GitHub 上，导航到存储库的主页面。\n\n2. 在仓库名称下，单击 “Settings”\\*\\*\\*\\*。 如果看不到“设置”选项卡，请选择“”下拉菜单，然后单击“设置”。\n\n \n\n3. 在边栏中的“代码、规划和自动化”下， 单击 **Codespaces**。\n\n4. 在页面的“预生成配置”部分，单击“设置预生成”。\n\n \n\n5. 选择要为其设置预生成的分支。\n\n \n\n > \\[!NOTE]\n > 从启用预生成版本的基础分支创建的任何分支通常也会获得相同开发容器配置的预生成版本。 例如，如果在存储库的默认分支上为开发容器配置文件启用预生成，则大多数情况下，基于默认分支的分支也会获得同一开发容器配置的预生成。\n\n6. 可以选择地，在显示的“配置文件”的下拉菜单中，选择要用于预生成的 \\*\\*\\*\\* 配置文件。 请参阅“[开发容器简介](/zh/enterprise-cloud@latest/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#devcontainerjson)”。\n\n \n\n7. 选择要如何自动触发预生成更新。\n\n * **每次推送**（默认设置）- 通过此设置，预生成将在每次对给定分支进行推送时更新。 这可确保从预生成生成的 codespace 始终包含最新的 codespace 配置，包括任何最近添加或更新的依赖项。\n\n * **配置更改时** - 借助此设置，更改以下任何文件时都会更新预生成：\n * `.devcontainer/devcontainer.json`\n\n > \\[!NOTE]\n\n`devcontainer.json` 的子目录中的 `.devcontainer` 文件更改不会触发预生成更新。\n\n```\n * `build.dockerfile` 文件的 `.devcontainer/devcontainer.json` 属性中引用的 Dockerfile。\n\n 此设置可确保在从预生成生成 codespace 时使用对存储库的开发容器配置文件进行的更改。 \n```\n\nGitHub Actions更新预生成工作流的运行频率较低，因此此选项使用更少的GitHub Actions分钟数。 但是，此选项不保证 codespace 始终包含最近添加或更新的依赖项，因此在创建 codespace 后可能需要手动添加或更新这些依赖项。\n\n* **计划** - 使用此设置，可以根据你定义的自定义计划更新预生成。 但是，这可以减少分钟消耗 GitHub Actions 量，但使用此选项，可能会创建不使用最新开发容器配置更改的代码空间。\n\n\n\n1. 根据需要，可以选择“减少仅对特定区域可用的预生成”，以便仅在指定区域中创建预生成。 选择要在其中提供预生成的区域。\n\n 默认情况下，预生成文件会在所有可用区域内创建，每个预生成文件都会产生存储费用。\n\n \n\n > \\[!NOTE]\n >\n > * 每个区域的预生成会产生单独的存储费用。 因此，您应只为已知将使用的区域启用预构建。\n > * 开发人员可以为其 GitHub Codespaces设置其默认区域，从而允许为更少的区域启用预生成。 请参阅“[为 GitHub Codespaces 设置默认区域](/zh/enterprise-cloud@latest/codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces)”。\n\n2. 根据需要，可以在“模板历史记录”下设置要保留的预生成模板版本数。 可以输入介于 1 和 5 之间的任意数字。 默认保存的版本数为 2，这意味着只保存最新版本的和上一个版本的预生成。\n\n \n\n 根据预生成触发器设置，预生成可能会随每个推送或每个开发容器配置的更改而更改。 保留较旧版本的预生成构建允许你使用不同于当前预生成的开发容器配置，从较旧的提交中创建预生成构建。 通过此设置可将保留的版本数设置为所需的级别。\n\n 如果将预生成版本数设置为 1， GitHub Codespaces 则只会保存预生成的最新版本，并在每次更新模板时删除旧版本。 这意味着，如果返回到较旧的开发容器配置，则不会获取预生成的 codespace。\n\n 保留的每个预生成版本都需支付存储费用。 例如，如果要在 4 个区域中生成预生成并保留 2 个版本，则最多需要支付 8 个预生成的存储费用。 请参阅“[GitHub Codespaces 计费](/zh/enterprise-cloud@latest/billing/concepts/product-billing/github-codespaces#pricing)”。\n\n3. 根据需要，可以添加用户或团队，以便在此配置的预生成工作流运行失败时发出通知。 可以开始键入用户名、团队名称或全名，然后在显示名称后单击该名称以将其添加到列表中。 发生预生成失败时，添加的用户或团队将收到电子邮件，其中包含工作流运行日志链接，以帮助进一步调查。\n\n \n\n > \\[!NOTE]\n > 只有当用户在其个人设置中启用了针对失败的 Actions 工作流的通知时，他们才会收到预生成失败的通知。 请参阅“[工作流程运行通知](/zh/enterprise-cloud@latest/actions/concepts/workflows-and-actions/notifications-for-workflow-runs)”。\n\n4. 根据需要，单击页面底部的“显示高级选项”。\n\n \n\n 在“高级选项”部分中，如果选择“禁用预生成优化”，则在最新的预生成工作流失败或当前正在运行时，将在没有预生成的情况下创建 Codespaces。 请参阅“[对预构建进行故障排除](/zh/enterprise-cloud@latest/codespaces/troubleshooting/troubleshooting-prebuilds#preventing-out-of-date-prebuilds-being-used)”。\n\n5. 单击 **“创建”** 。\n\n 如果存储库的开发容器配置指定了访问其他存储库的权限，你将看到一个授权页面。 有关 `devcontainer.json` 文件中如何指定此内容的详细信息，请参阅“[管理对代码空间中其他存储库的访问权限](/zh/enterprise-cloud@latest/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces)”。\n\n 单击 查看请求权限的详细信息。\n\n \n\n 单击“授权并继续”，授予这些权限来创建预生成。 另外，可以单击“在未经授权的情况下继续”，但如果这样做，从生成的预生成创建的 codespace 可能无法正常工作。\n\n > \\[!NOTE]\n > 使用此预生成创建 Codespaces 的用户也需要授予这些权限。\n\n创建预生成配置后，该配置会在存储库设置的页面上列出 GitHub Codespaces 。\nGitHub Actions工作流已排队，然后运行，以根据所选的分支和开发容器配置文件在指定的区域中创建预生成。\n\n\n\n有关编辑和删除预生成配置的信息，请参阅 [管理预构建](/zh/enterprise-cloud@latest/codespaces/prebuilding-your-codespaces/managing-prebuilds)。\n\n## 配置环境变量\n\n若要允许预生成过程访问创建开发环境所需的环境变量，可以将这些 Codespaces 变量设置为存储库机密或 Codespaces 组织机密。 以这种方式创建的机密将可被任何从此存储库创建代码空间的人访问。 请参阅“[管理存储库或组织的开发环境机密](/zh/enterprise-cloud@latest/codespaces/managing-codespaces-for-your-organization/managing-development-environment-secrets-for-your-repository-or-organization#adding-secrets-for-a-repository)”。\n\n预构建在创建代码空间环境时不能使用用户级别的机密，因为这些机密在代码空间创建完成后才会可用。\n\n## 配置在预构建中包含的耗时任务\n\n可以在 `onCreateCommand` 中使用 `updateContentCommand` 和 `devcontainer.json` 命令，将耗时的过程包含在预构建创建中。\nVisual Studio Code请参阅文档， [devcontainer.json 参考](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts)。\n\n`onCreateCommand` 只在创建预生成时运行一次，而 `updateContentCommand` 在预生成创建和预生成后续更新时运行。 增量生成应包含在 `updateContentCommand` 中，因为它们代表项目的源，并且需要包含在每次预生成更新中。\n\n## 延伸阅读\n\n* [允许预构建访问其他存储库](/zh/enterprise-cloud@latest/codespaces/prebuilding-your-codespaces/allowing-a-prebuild-to-access-other-repositories)\n* [对预构建进行故障排除](/zh/enterprise-cloud@latest/codespaces/troubleshooting/troubleshooting-prebuilds)"}