跳至主要内容

限制 Codespaces 的保留期

您可以为组织拥有的任何 Codespaces 设置最长保留期。

谁可以使用此功能?

若要管理组织 Codespaces 的保留约束,您必须是该组织的所有者。

GitHub Team 和 GitHub Enterprise 计划中的组织可以支付其成员和协作者使用 GitHub Codespaces 的费用。然后,这些组织可以访问组织支付的 Codespaces 的设置和策略。有关更多信息,请参阅“选择组织中 Codespaces 的所有者和付费人”和“GitHub 的计划”。

概述

GitHub Codespaces 在停止且保持非活动状态达到一定天数后会自动删除。每个 Codespace 的保留期在创建 Codespace 时设置,并且不会更改。默认保留期为 30 天。

GitHub 用户可以为其创建的 Codespace 设置小于 30 天的个人保留期。有关详细信息,请参阅“配置 Codespace 的自动删除”。

作为组织所有者,你可能希望配置对组织拥有的存储库创建的 Codespace 的最长保留期的约束。这可以帮助你限制与停止然后闲置直至自动删除的 Codespace 相关的存储成本。有关存储费用的详细信息,请参阅“关于 GitHub Codespaces 的计费”。你可以为组织拥有的所有存储库或特定存储库设置最长保留期。

注意:为存储库设置最长保留策略可防止人们将 Codespace 豁免于自动删除。对于为该存储库创建的 Codespace,“保留 Codespace”选项将不可用。有关详细信息,请参阅“配置 Codespace 的自动删除”。

设置组织范围和存储库特定策略

创建策略时,你可以选择将其应用于组织中的所有存储库,或仅应用于指定的存储库。如果你创建具有 Codespace 保留约束的组织范围策略,则针对特定存储库的任何策略中的保留约束应短于为整个组织配置的限制,否则它们将不起作用。将应用最短保留期 - 在组织范围策略、针对指定存储库的策略或某人的个人设置中的默认保留期中。

如果你添加具有保留约束的组织范围策略,则应将保留期设置为最长的可接受期限。然后,你可以添加单独的策略,将组织中特定存储库的最大保留期设置为较短的期限。

注意:Codespaces 策略仅适用于您的组织付费的 Codespaces。如果有人自费为组织中的存储库创建 Codespace,则 Codespace 不会受这些策略约束。有关更多信息,请参阅“选择组织中 Codespaces 的所有者和付费人”。

添加策略以设置最长 Codespace 保留期

  1. 在 GitHub 的右上角,选择您的个人资料图片,然后单击 您的组织.

  2. 在组织旁边,单击设置

  3. 在侧边栏的“代码、规划和自动化”部分,选择 Codespaces,然后单击策略

  4. 在“Codespaces 策略”页面上,单击创建策略

  5. 输入新策略的名称。

  6. 单击添加约束并选择保留期

  7. 单击 以编辑约束。

  8. 输入 Codespaces 在自动删除之前可以保持停止状态的最长天数,然后单击保存

    Screenshot of a dropdown with a field labeled "Maximum value" set to 8 days. Below this are "Cancel" and "Save" buttons.

    注释

    • 在此上下文中,一天是指 24 小时,从 Codespace 停止的时间开始计算。
    • 有效范围为 0-30 天。
    • 将此期限设置为0会导致 Codespaces 在停止或因不活动而超时时立即删除。
  9. 默认情况下,此策略设置为适用于所有存储库,如果您希望它仅适用于组织中的一些存储库,请单击所有存储库,然后在下拉菜单中单击选定的存储库

    Screenshot of the repository selection dropdown, showing the options "All repositories" and "Selected repositories."

    注意:如果您要向已包含“每个用户最多 Codespaces”约束的现有策略添加约束,则无法将策略应用于选定的存储库。这是因为“每个用户最多 Codespaces”约束始终适用于组织中的所有存储库。

    已选择所选存储库

    1. 单击 .

      Screenshot of the settings icon (a gear symbol) to the left of a button labeled "Selected repositories."

    2. 选择要对此策略应用的存储库。

    3. 在存储库列表底部,单击选择存储库

      Screenshot of a list of repositories, each with a checkbox. Three repositories are selected.

  10. 如果您希望向策略添加另一个约束,请单击添加约束并选择另一个约束。有关其他约束的信息,请参阅

  11. 在完成向策略添加约束后,单击保存

此策略将应用于所有向您的组织计费的新代码空间。保留期约束仅在创建代码空间时应用。

编辑策略

您可以编辑现有策略。例如,您可能希望向策略添加或从中删除约束。

保留期约束仅在创建代码空间时应用于代码空间。编辑策略对现有代码空间没有影响。

  1. 显示“代码空间策略”页面。有关更多信息,请参阅“添加策略以设置最长代码空间保留期”。
  2. 单击要编辑的策略的名称。
  3. 在“保留期”约束旁边,单击 .
  4. 进行所需的更改,然后单击保存

删除策略

您可以随时删除策略。删除策略对现有代码空间没有影响。

  1. 显示“代码空间策略”页面。有关更多信息,请参阅“添加策略以设置最长代码空间保留期”。

  2. 单击要删除的策略右侧的删除按钮。

  3. 单击 要删除的策略的右侧。

    Screenshot of a policy with the delete button (a trash can icon) highlighted with a dark orange outline.