跳至主要内容

管理预构建

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

谁可以使用此功能?

所有个人帐户拥有的存储库都提供针对 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.com.

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

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 时可用。

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

  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. 单击确定以确认删除。

手动触发预构建

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

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

  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.

进一步阅读