跳至主要内容

配置 Codespaces 的自动删除

不活动的 Codespaces 会自动删除。您可以选择保留已停止的 Codespaces 的时间长度,最长可达 30 天。

默认情况下,GitHub Codespaces 在停止后且保持不活动状态 30 天后会自动删除。

但是,由于 GitHub Codespaces 会产生存储费用,您可能更倾向于缩短保留期限,方法是在 GitHub Codespaces 的个人设置中更改默认期限。有关存储费用的更多信息,请参阅“GitHub Codespaces计费说明”。

注意

无论您是否设置了个人 codespace 保留期限,养成删除不再需要的 codespace 的习惯都是一个好主意。请参阅“删除 codespace”。

自动删除会发生,无论 codespace 是否包含未推送的更改。要防止 codespace 自动删除,只需再次打开 codespace 即可。每次连接到 codespace 时,保留期限都会重置,并且在 codespace 停止时,保留倒计时会重新开始。

如果某个仓库属于某个组织,则组织所有者可能已为整个组织设置了保留期限。如果此期限短于您个人设置中的默认保留期限,则组织保留期限将应用于您为此仓库创建的 codespace。请参阅“限制 Codespaces 的保留期限”。

每个 codespace 都有其自己的保留期限。因此,您可能拥有保留期限不同的 codespace。例如,如果

  • 您创建了一个 codespace,更改了默认保留期限,然后又创建了另一个 codespace。
  • 您使用 GitHub CLI 创建了一个 codespace 并指定了不同的保留期限。
  • 您为组织拥有的仓库创建了一个 codespace,该仓库在组织设置中配置了保留期限。您创建的 codespace 的所有权显示在“您的 codespaces”页面上。

注意

保留期限以天为单位。一天代表一个 24 小时周期,从您停止 codespace 的时间开始。

设置 Codespaces 的默认保留期限

  1. 在 GitHub 上任何页面的右上角,单击您的个人资料照片,然后单击 设置.

  2. 在侧边栏的“代码、规划和自动化”部分,单击 Codespaces

  3. 在“默认保留期限”下,输入您希望默认情况下在 codespace 停止后保留 codespace 的天数。

    Screenshot of the "Default retention period" setting, currently set to 1 day. Next to the number of days is the "Save" button.

    您可以将默认保留期限设置为030天。

    警告

    将期限设置为0将导致您的 codespace 在您停止它们时或由于 inactivity 而超时时立即删除。请参阅“设置 GitHub Codespaces 的超时期限”。

  4. 单击保存

使用 GitHub CLI 创建 codespace 时,您可以覆盖此默认设置。如果您在指定了较短保留期限的组织中创建 codespace,则组织级别值将覆盖您的个人设置。

如果您设置的保留期限超过一天,您将在删除前一天收到电子邮件通知。

检查距离自动删除还剩多少时间

您可以检查 codespace 是否即将自动删除。

当非活动 codespace 即将达到其保留期限时,这将在 GitHub 上的 codespace 列表中显示,网址为 https://github.com/codespaces

Screenshot of a list of three codespaces. The third of these is labeled "Expiring in 4 days" which is highlighted with a dark orange outline.

避免 Codespaces 自动删除

您可能有一个 codespace,您希望将其保留的时间长于个人设置中定义的保留期限。您可以使用“保留 codespace”选项来实现此目的。当您选择此选项时,您的 codespace 将无限期保留,直到您手动删除它。

注意

受组织保留策略影响的组织拥有的 codespace 无法使用“保留 codespace”选项。

Codespaces 会产生存储费用,或者如果 codespace 由您的个人 GitHub 帐户拥有,则会消耗您的包含存储配额。因此,您应了解无限期存储 codespace 的成本影响。请参阅“GitHub Codespaces计费说明”。

  1. 在 GitHub 的左上角,选择,然后单击 Codespaces 以转到 github.com/codespaces 上的“您的 codespaces”页面。

  2. 在您想要免除自动删除的 codespace 的右侧,单击,然后单击 保留 codespace

    Screenshot of the dropdown menu for an active codespace. The "Keep codespace" option has a tooltip saying "Expires 10 days after shutdown."

您已免除自动删除的 Codespaces 在您的 Codespaces 列表中用书签图标 ().

Screenshot of a section of the codespaces list, showing a codespace labeled with the bookmark icon.

设置 codespace 的保留期限

如果您已安装 GitHub CLI,则可以使用它来使用 GitHub Codespaces。有关 GitHub CLI 的安装说明,请参阅 GitHub CLI 仓库

要在创建 codespace 时设置 codespace 保留期限,请将--retention-period标志与codespace create子命令一起使用。以天为单位指定期限。期限必须在 0 到 30 天之间。

gh codespace create --retention-period DAYS

如果您在创建 codespace 时未指定保留期限,则将使用您的默认保留期限或组织保留期限,具体取决于哪个较低。有关设置默认保留期限的信息,请单击此页面上的“Web 浏览器”选项卡。

要了解有关 GitHub CLI 的更多信息,请参阅“关于 GitHub CLI”。

设置保留期限

您可以在 GitHub 上的 Web 浏览器中设置默认保留期限。或者,如果您使用 GitHub CLI 创建 codespace,则可以为此特定 codespace 设置保留期限。有关更多信息,请单击上面的相应选项卡。

检查 Codespaces 是否即将自动删除

您可以在 Visual Studio Code 桌面应用程序中检查 codespace 是否即将自动删除。

  1. 在 VS Code 中,在活动栏中,单击远程资源管理器图标。

    Screenshot of the Activity Bar. The icon for the "Remote Explorer" side bar (a rectangle overlaid by a circle) is highlighted with an orange outline.

    注意

    如果活动栏中未显示远程资源管理器

    1. 访问命令面板。例如,通过按Shift+Command+P(Mac)/Ctrl+Shift+P(Windows/Linux)。
    2. 输入:details
    3. 单击Codespaces:详细信息
  2. 从远程资源管理器右上角的下拉菜单中选择GitHub Codespaces,如果尚未选择。

  3. 在“GITHUB CODESPACES”下,将鼠标指针放在您感兴趣的 codespace 上。将显示一个弹出框,其中显示有关 codespace 的信息。

    如果 codespace 即将达到其保留期限,则会包含一行说明此期限何时到期。

    Screenshot of the "Remote Explorer" side bar. In the right-click menu for a codespace, "Expiring in 19 days" is highlighted with an orange outline.

进一步阅读