跳至主要内容

配置 Codespaces 的自动删除

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

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

但是,由于 GitHub Codespaces 会产生存储费用,因此您可能希望通过更改 GitHub Codespaces 个人设置中的默认期限来缩短保留期。有关存储费用的更多信息,请参阅“关于 GitHub Codespaces 的计费”。

注意

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

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

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

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

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

注意

保留期限以天为单位指定。一天表示 24 小时,从您停止 Codespace 的时间开始。

设置 Codespaces 的默认保留期限

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

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

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

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

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

    警告

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

  4. 点击保存

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

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

检查自动删除前的剩余时间

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

当不活动的 Codespace 即将达到其保留期限时,将在 GitHub 上的 Codespaces 列表中显示此信息,网址为 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 将无限期保留,直到您手动删除它。

注意

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

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

  1. 在 GitHub 的左上角,选择,然后点击 Codespaces 将您带到“您的 Codespaces”页面,网址为 github.com/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.

进一步阅读