跳至主要内容

管理预构建

您可以查看、修改和删除存储库的预构建配置。

谁可以使用此功能?

个人帐户拥有的所有存储库都提供存储库级 GitHub Codespaces 设置。

对于组织拥有的存储库,GitHub Codespaces 的存储库级设置适用于 GitHub Team 和 GitHub Enterprise 计划上的组织。要访问设置,组织或其父级企业必须添加付款方式并为 GitHub Codespaces 设置支出限额。有关更多信息,请参阅“选择谁拥有和支付组织中的 Codespaces”和“GitHub 的计划”。

关于管理预构建

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

根据预构建配置中的设置,更新预构建的工作流可能会由以下事件触发

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

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

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

要查找托管预构建配置的所有存储库,您必须按照“查看您的 GitHub Codespaces 用量”中的步骤获取使用情况报告的副本。

查看预构建的进度

您可以在存储库设置的 GitHub Codespaces 页面上查看您设置的每个预构建配置的最新工作流运行的当前状态。例如,“正在运行”或“上次运行于 1 小时前”。

要查看最新预构建工作流运行的日志输出,请单击查看输出

Screenshot of the "Prebuild configuration" page. Two prebuild configurations are listed. The "See output" button for one configuration is highlighted.

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

Screenshot of the prebuild workflow output in the "Actions" tab of GitHub.

或者,要查看与指定分支关联的所有预构建工作流运行,请选择下拉菜单,然后单击查看运行

Screenshot of the options dropdown menu for a configuration, shown by clicking a button labeled with three dots. The "View runs" option is selected.

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

Screenshot of the "Codespaces Prebuilds" list showing a run history for prebuild workflows.

编辑预构建配置

  1. 在存储库设置的 Codespaces 页面上,单击要编辑的预构建配置右侧的省略号。

  2. 在下拉菜单中,单击编辑

    Screenshot of the options dropdown menu for a configuration, displayed by clicking a button labeled with three dots. The "Edit" option is selected.

  3. 对预构建配置进行所需的更改,然后单击更新

    如果存储库的开发容器配置指定了访问其他存储库的权限,则会显示一个授权页面。有关如何在devcontainer.json文件中指定此内容的更多信息,请参阅“管理 Codespace 内对其他存储库的访问权限”。

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

    Screenshot of an authorization page for a prebuild configuration. Three permissions are listed in this request.

    单击授权并继续以授予这些权限以创建预构建。或者,您可以单击继续但不授权,但如果您这样做,则从生成的预构建创建的 Codespace 可能无法正常工作。

    注意

    使用此预构建创建 Codespace 的用户也将被要求授予这些权限。

禁用预构建配置

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

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

  1. 在存储库设置的 Codespaces 页面上,单击要禁用的预构建配置右侧的省略号。

  2. 在下拉菜单中,单击禁用运行

    Screenshot of the options dropdown menu for a configuration, shown by clicking a button labeled with three dots. The "Disable runs" option is selected.

  3. 要确认您要禁用此配置,请单击确定

删除预构建配置

注意

您可以通过获取“使用情况报告”的副本找到包含预构建的存储库列表。

删除预构建配置也会删除该配置之前创建的所有预构建。因此,在您删除配置后不久,该配置生成的预构建在您创建新的 Codespace 时将不再可用。

删除预构建配置后,已排队或已启动的该配置的工作流运行仍将运行。它们将与之前完成的工作流运行一起列在工作流运行历史记录中。

  1. 在存储库设置的 Codespaces 页面上,单击要删除的预构建配置右侧的省略号。

  2. 在下拉菜单中,单击删除

    Screenshot of the options dropdown menu for a configuration, displayed by clicking a button labeled with three dots. The "Delete" option is selected.

  3. 单击确定以确认删除。

手动触发预构建

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

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

  2. 在下拉菜单中,单击手动触发

    Screenshot of the options dropdown menu for a configuration, shown by clicking a button labeled with three dots. The "Manually trigger" option is selected.

进一步阅读