管理预生成

你可以查看、修改和删除存储库的预生成配置。

谁可以使用此功能？

GitHub Codespaces 的存储库级设置适用于个人帐户拥有的所有存储库。

对于组织拥有的存储库，GitHub Codespaces 的存储库级别设置适用于使用 GitHub Team 和 GitHub Enterprise 计划的组织。 要访问设置，组织或其父企业必须已添加付款方式并为 GitHub Codespaces 设置了支出限制。 有关详细信息，请参阅“选择谁拥有组织中的 codespace 并为其付费”和“GitHub 的计划”。

本文内容

关于管理预生成

为存储库配置的预生成是使用 GitHub Actions 工作流（由 GitHub Codespaces 服务管理）创建和更新的。

根据预生成配置中的设置，更新预生成的工作流可能会由以下事件触发：

  • 创建或更新预生成配置
  • 将提交或拉取请求推送到配置为具有预生成的分支
  • 更改任何开发容器配置文件
  • 在预生成配置中定义的计划
  • 手动触发工作流

预生成配置中的设置确定哪些事件会自动触发预生成的更新。 请参阅“配置预生成”。

具有存储库管理员访问权限的人员可以检查预生成的进度以及编辑和删除预生成配置。

要查找承载预生成配置的所有存储库，必须按照“查看 GitHub Codespaces 使用情况”中的步骤获取使用情况报告的副本。

查看预生成的进度

可以在存储库设置的 GitHub Codespaces 页上查看所设置的每个预生成配置的最新工作流运行的当前状态。 例如，“当前正在运行”或“1 小时前最后一次运行”。

若要查看最新预生成工作流运行的日志输出，请单击“查看输出”。

“预生成配置”页的屏幕截图。 列出了两个预生成配置。 一个配置的“查看输出”按钮已突出显示。

这会在“操作”选项卡中显示工作流的最近一次运行的输出。

该屏幕截图显示了 GitHub 的“操作”选项卡中的预生成工作流输出。

或者，若要查看与指定分支关联的所有预生成工作流运行，请选择 下拉菜单，然后单击“查看运行”。

该屏幕截图显示了配置的选项下拉菜单，该下拉菜单通过单击标有三个点的按钮显示。 已选中“视图运行”选项。

这将显示关联分支的预生成工作流运行历史记录。

该屏幕截图显示了“Codespaces 预生成”列表，其中显示了预生成工作流的运行历史记录。

编辑预生成配置

  1. 在存储库设置的 Codespaces 页上，单击要编辑的预生成配置右侧的省略号。

  2. 在下拉菜单中，单击“编辑”。

    该屏幕截图显示了配置的选项下拉菜单，该下拉菜单通过单击标有三个点的按钮显示。 已选中“编辑”选项。

  3. 对预生成配置进行所需的更改，然后单击“更新”。

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

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

    预生成配置的授权页的屏幕截图。 此请求中列出了三种权限。

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

    Note

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

禁用预生成配置

若要暂停更新配置的预生成，可以禁用配置的工作流运行。 为预生成配置禁用工作流运行不会删除以前为该配置创建的任何预生成，因此，codespace 将继续从现有预生成生成。

如果需要调查预生成创建失败，则禁用预生成配置的工作流运行非常有用。

  1. 在存储库设置的 Codespaces 页上，单击要禁用的预生成配置右侧的省略号。

  2. 在下拉菜单中，单击“禁用运行”。

    该屏幕截图显示了配置的选项下拉菜单，该下拉菜单通过单击标有三个点的按钮显示。 已选中“禁用运行”选项。

  3. 若确认要禁用此配置，请单击“确定”。

删除预生成配置

Note

可以通过获取“使用情况报告”的副本来查找包含预生成的存储库列表。

删除预生成配置还会删除以前为该配置创建的所有预生成。 因此，删除配置后不久，在创建新 codespace 时，该配置生成的预生成将不再可用。

删除预生成配置后，该配置已排队或启动的工作流仍将运行。 它们将连同以前完成的工作流运行一起列在工作流运行历史记录中。

  1. 在存储库设置的 Codespaces 页上，单击要删除的预生成配置右侧的省略号。

  2. 在下拉菜单中，单击“删除”。

    该屏幕截图显示了配置的选项下拉菜单，该下拉菜单通过单击标有三个点的按钮显示。 已选中“删除”选项。

  3. 单击“确定”确认删除操作。

手动触发预生成

手动触发预生成配置的工作流运行可能很有用。 通常，只有在调试预生成配置的工作流的问题时，才有必要这样做。

  1. 在存储库设置的 Codespaces 页上，单击要触发其工作流的预生成配置右侧的省略号。

  2. 在下拉菜单中，单击“手动触发”。

    该屏幕截图显示了配置的选项下拉菜单，该下拉菜单通过单击标有三个点的按钮显示。 已选中“手动触发”选项。

延伸阅读