Gerenciando pré-compilações

Você pode revisar, modificar e excluir as configurações de pré-compilação do seu repositório.

Quem pode usar esse recurso?

As configurações de nível do repositório para o GitHub Codespaces estão disponíveis para todos os repositórios pertencentes a contas pessoais.

Para os repositórios pertencentes a organizações, as configurações de nível do repositório do GitHub Codespaces estão disponíveis para as organizações com os planos do GitHub Team e do GitHub Enterprise. Para acessar as configurações, a organização ou a empresa matriz precisa ter adicionado uma forma de pagamento e definido um limite de gastos para o GitHub Codespaces. Para obter mais informações, confira "Como escolher quem tem a propriedade e paga pelos codespaces em sua organização" e "Planos do GitHub."

Neste artigo

Sobre o gerenciamento de pré-builds

As predefinições que você configura para um repositório são criadas e atualizadas usando um fluxo de trabalho do GitHub Actions, gerenciado pelo serviço de GitHub Codespaces.

Dependendo das configurações em uma configuração de pré-compilação, o fluxo de trabalho para atualizar a pré-compilação pode ser acionado por estes eventos:

  • Criando ou atualizando a configuração de pré-compilação
  • Enviando por push um commit ou um pull request para um branch configurado para pré-compilações
  • Alteração a qualquer um dos arquivos de configuração do contêiner de desenvolvimento
  • Um agendamento que você definiu na configuração de pré-compilação
  • Acionando manualmente o fluxo de trabalho

As configurações na configuração de pré-compilação determinam quais eventos disparam automaticamente uma atualização da pré-compilação. Para obter mais informações, confira "Configurando as pré-criações".

As pessoas com acesso de administrador a um repositório podem verificar o progresso de pré-compilações, editar e excluir configurações de pré-criação.

Para localizar todos os repositórios que hospedam uma configuração de pré-compilação, você deve obter uma cópia do relatório de uso seguindo as etapas de "Como visualizar o uso do GitHub Codespaces".

Visualizando o progresso das pré-compilações

É possível exibir o status atual da última execução de fluxo de trabalho de cada configuração de pré-compilação definida na página de GitHub Codespaces das configurações do repositório. Por exemplo, "Atualmente em execução" ou "Última execução 1 hora atrás".

Para ver a saída do log para a última execução do fluxo de trabalho pré-build, clique em Ver saída.

Captura de tela da página "Configuração de predefinição". Duas configurações de predefinição estão listadas. O botão "Ver saída" para uma configuração está realçado.

Isso exibirá a saída da execução mais recente do fluxo de trabalho na guia Ações.

Captura de tela da saída do fluxo de trabalho de predefinição na guia "Ações" do GitHub.com.

Como alternativa, para exibir todas as execuções de fluxo de trabalho de predefinição associadas ao branch especificado, selecione o menu suspenso do e clique em Exibir execuções.

Captura de tela do menu suspenso de opções para uma configuração, mostrado ao clicar em um botão rotulado com três pontos. A opção "Exibir execuções" está selecionada.

Exibe o histórico de execução de fluxo de trabalho para pré-compilações para o branch associado.

Captura de tela da lista "Predefinições de Codespaces" mostrando um histórico de execuções para fluxos de trabalho de predefinições.

Editando uma configuração de pré-compilação

  1. Na página de Codespaces das configurações do repositório, clique nas reticências à direita da configuração de pré-compilação que você deseja editar.

  2. No menu suspenso, clique em Editar.

    Captura de tela do menu suspenso de opções para uma configuração, mostrado ao clicar em um botão rotulado com três pontos. A opção "Editar" está selecionada.

  3. Faça as alterações necessárias na configuração de pré-build e clique em Atualizar.

    Se a configuração do contêiner de desenvolvimento para o repositório especificar permissões para acessar outros repositórios, será mostrada uma página de autorização. Para obter mais informações sobre como isso é especificado no arquivo devcontainer.json, confira "Gerenciar o acesso a outros repositórios em seu codespace".

    Clique em para exibir os detalhes das permissões solicitadas.

    Captura de tela de uma página de autorização para uma configuração de pré-compilação. Três permissões são listadas nesta solicitação.

    Clique em Autorizar e continuar para conceder essas permissões para a criação de pré-compilações. Como alternativa, você pode clicar em Continuar sem autorizar, mas, se fizer isso, os codespaces criados com base na pré-compilação resultante poderão não funcionar corretamente.

    Observação: os usuários que criarem codespaces usando essa pré-compilação também serão solicitados a conceder essas permissões.

Desabilitar uma configuração de pré-compilação

Para pausar a atualização da pré-compilação de uma configuração, você pode desabilitar execuções de fluxo de trabalho da configuração. Desabilitar as execuções de fluxo de trabalho para uma configuração de pré-compilação não exclui nenhuma pré-compilação criada anteriormente para essa configuração e, como resultado, os espaços de código continuarão a ser gerados a partir de uma pré-compilação existente.

Ao investigar falhas de criação de pré-compilação, pode ser útil desabilitar as execuções de fluxo de trabalho de uma configuração de pré-compilação.

  1. Na página do Codespaces das configurações do repositório, clique nas reticências à direita da configuração de pré-compilação que você deseja desabilitar.

  2. No menu suspenso, clique em Desabilitar execuções.

    Captura de tela do menu suspenso de opções para uma configuração, mostrado ao clicar em um botão rotulado com três pontos. A opção "Desabilitar execuções" está selecionada.

  3. Para confirmar se você deseja desabilitar essa configuração, clique em OK.

Excluindo uma configuração de pré-compilação

Observação: você pode encontrar uma lista dos repositórios que contém uma pré-compilação obtendo uma cópia do seu "relatório de uso".

A exclusão de uma configuração de pré-compilação também exclui todas as pré-compilações criadas anteriormente para essa configuração. Como resultado, logo após você excluir uma configuração, as pré-compilações geradas por essa configuração não estarão disponíveis ao criar um novo codespace.

Depois que você excluir uma configuração de pré-compilação, as execuções do fluxo de trabalho que foram enfileirados ou iniciados ainda serão executadas. Elas serão listados no histórico de execução de fluxo de trabalho junto com execuções de fluxo de trabalho concluídas anteriormente.

  1. Na página de Codespaces das configurações do repositório, clique nas reticências à direita da configuração de pré-compilação que você deseja excluir.

  2. No menu suspenso, clique em Excluir.

    Captura de tela do menu suspenso de opções para uma configuração, mostrado ao clicar em um botão rotulado com três pontos. A opção "Excluir" está selecionada.

  3. Clique em OK para confirmar a exclusão.

Acionar pré-compilações manualmente

Pode ser útil acionar manualmente a execução de um fluxo de trabalho para uma configuração de pré-compilação. Geralmente, isso só será necessário se você estiver depurando um problema com o fluxo de trabalho de uma configuração de pré-compilação.

  1. Na página de Codespaces das configurações do repositório, clique nas reticências à direita da configuração de pré-compilação cujo fluxo de trabalho você deseja acionar.

  2. No menu suspenso, clique em Disparar manualmente.

    Captura de tela do menu suspenso de opções para uma configuração, mostrado ao clicar em um botão rotulado com três pontos. A opção "Disparar manualmente" está selecionada.

Leitura adicional