Como configurar a exclusão automática de seus codespaces

Neste artigo

Os codespaces inativos são excluídos automaticamente. Você pode escolher por quanto tempo seus codespaces parados são retidos, até, no máximo, 30 dias.

Por padrão, os GitHub Codespaces são excluídos automaticamente depois que são parados e continuam inativos por 30 dias.

Mas como os GitHub Codespaces geram encargos de armazenamento, talvez você prefira reduzir o período de retenção alterando o período padrão nas suas configurações pessoais dos GitHub Codespaces. Para saber mais sobre preços de armazenamento, confira "Sobre o faturamento do GitHub Codespaces".

Observação: tendo definido ou não um período de retenção de codespace pessoal, é uma boa ideia se acostumar a excluir codespaces de que você não precisa mais. Para obter mais informações, confira "Excluir um codespace".

A exclusão automática ocorre independentemente de um codespace conter alterações não enviadas por push. Para evitar a exclusão automática de um codespace, bastará abrir o codespace novamente. O período de retenção será redefinido sempre que você se conectar a um codespace, e a contagem regressiva de retenção será reiniciada quando o codespace for parado.

Se um repositório pertencer a uma organização, o proprietário da organização poderá ter definido um período de retenção para toda a organização. Se esse período for menor do que o período de retenção padrão em suas configurações pessoais, o período de retenção da organização se aplicará aos codespaces criados para esse repositório. Para obter mais informações, confira "Como restringir o período de retenção de codespaces".

Cada codespace tem seu próprio período de retenção. Portanto, você pode ter codespaces com diferentes períodos de retenção. Por exemplo, se:

  • Você criou um codespace, alterou o período de retenção padrão e criou outro codespace.
  • Você criou um codespace usando a GitHub CLI e especificou um período de retenção diferente.
  • Você criou um codespace de um repositório de propriedade da organização que tem um período de retenção configurado nas definições da organização. A propriedade dos codespaces que você cria é mostrada na página "Seus codespaces".

Observação: o período de retenção é especificado em dias. Um dia representa um período de 24 horas, começando na hora do dia em que você para um codespace.

Como definir um período de retenção padrão para seus codespaces

  1. No canto superior direito de qualquer página, clique na foto do seu perfil e em Configurações.

    Captura de tela do menu da conta do GitHub mostrando as opções para os usuários exibirem e editarem o perfil, o conteúdo e as configurações. Há um item de menu "Configurações" com o contorno em laranja escuro.

  2. Na seção "Código, planejamento e automação" da barra lateral, clique em Codespaces.

  3. Em "Período de retenção padrão", insira o número de dias pelos quais você deseja que seus codespaces sejam retidos por padrão depois de terem sido parados.

    Captura de tela da configuração "Período de retenção padrão", atualmente definida como 1 dia. Ao lado do número de dias está o botão "Salvar".

    Você pode definir o período de retenção padrão entre 0 e 30 dias.

    Aviso: a configuração do período como 0 resultará na exclusão imediata dos codespaces quando eles forem parados ou quando o tempo limite deles for atingido devido à inatividade. Para obter mais informações, confira "Como definir seu período de tempo limite para o GitHub Codespaces".

  4. Clique em Salvar.

Ao criar um codespace usando a GitHub CLI, você poderá substituir esse padrão. Se você criar um codespace em uma organização que especifica um período de retenção mais curto, o valor no nível da organização substituirá sua configuração pessoal.

Se você definir um período de retenção de mais de um dia, será enviada uma notificação por email um dia antes da exclusão.

Como verificar o tempo restante até a exclusão automática

Você pode verificar se um codespace deve ser excluído automaticamente em breve.

Quando um codespace inativo estiver se aproximando do final de seu período de retenção, isso será indicado na sua lista de codespaces no GitHub em https://github.com/codespaces.

Captura de tela de uma lista de três codespaces. O terceiro deles é rotulado como "Expirando em 4 dias", que é realçado com um contorno laranja escuro.

Como evitar a exclusão automática de codespaces

Você pode ter um codespace que deseja manter por mais tempo do que o período de retenção definido nas configurações pessoais. Faça isso usando a opção "Manter codespace". Quando você selecionar essa opção, o codespace será retido indefinidamente até que você o exclua manualmente.

Observação: a opção "Manter codespace" não está disponível para codespaces de propriedade da organização afetados por uma política de retenção da organização.

Os codespaces geram custos de armazenamento ou consomem a concessão de armazenamento incluída quando o codespace pertence à conta pessoal do GitHub. Portanto, você deve estar ciente das implicações de custo do armazenamento de codespaces indefinidamente. Para obter mais informações, confira "Sobre o faturamento do GitHub Codespaces".

  1. Navegue até a página "Seus codespaces" em github.com/codespaces.

  2. À direita do codespace que você deseja isentar da exclusão automática, clique em , depois em Manter codespace.

    Captura de tela do menu suspenso de um codespace ativo. A opção "Manter codespace" tem uma dica de ferramenta dizendo "Expira 10 dias após o desligamento".

Os codespaces isentos de exclusão automática são indicados na lista de codespaces com o ícone de indicador ().

Captura de tela de uma seção da lista de codespaces mostrando um codespace rotulado com o ícone de indicador.

Como definir um período de retenção para um codespace

Se você instalou a GitHub CLI, use-a para trabalhar com o GitHub Codespaces. Para obter instruções de instalação para GitHub CLI, veja o repositório GitHub CLI.

Para definir o período de retenção do codespace ao criar um codespace, use o sinalizador --retention-period com o subcomando codespace create. Especifique o período em dias. O período deve ter entre 0 e 30 dias.

gh codespace create --retention-period DAYS

Se você não especificar um período de retenção ao criar um codespace, o período de retenção padrão ou um período de retenção da organização será usado, dependendo do que for menor. Para obter informações sobre como definir um período de retenção padrão, clique na aba "Navegador da Web" nesta página.

Para saber mais sobre GitHub CLI, confira "Sobre o a CLI do GitHub".

Como definir o período de retenção

Você pode definir o período de retenção padrão no navegador da Web, no GitHub.com. Como alternativa, se usar a GitHub CLI para criar um codespace, você poderá definir um período de retenção para esse codespace específico. Para obter mais informações, clique na guia apropriada acima.

Como verificar se os codespaces serão automaticamente excluídos em breve

Você pode verificar, no aplicativo da área de trabalho do Visual Studio Code, se um codespace deve ser excluído automaticamente em breve.

  1. No VS Code, na barra de Atividades, clique no ícone do Gerenciador Remoto.

    Captura de tela da Barra de Atividades. O ícone da barra lateral do "Gerenciador Remoto" (um retângulo sobreposto por um círculo) está realçado com um contorno laranja.

    Observação: se o Gerenciador Remoto não for exibido na Barra de Atividades:

    1. Abra a paleta de comandos. Por exemplo, pressionando Shift+Command+P (no Mac) / Ctrl+Shift+P (no Windows/Linux).
    2. Digite: details.
    3. Clique em Codespaces: detalhes.

  2. Escolha GitHub Codespaces no menu suspenso no canto superior direito do Gerenciador Remoto se ele ainda não estiver selecionado.

  3. Em "GITHUB CODESPACES", posicione o ponteiro do mouse sobre o codespace no qual você está interessado. Uma caixa pop-up é exibida com informações sobre o codespace.

    Se o codespace estiver se aproximando do fim de seu período de retenção, será incluída uma linha informando quando o codespace será excluído.

    Captura de tela da barra lateral "Gerenciador Remoto". No menu de clique com o botão direito do mouse para um codespace, "Expirando em 19 dias" é realçado com um contorno laranja.