Skip to main content

Managing prebuilds

You can review, modify, and delete the prebuild configurations for your repository.

Os GitHub Codespaces estão disponíveis para organizações que usam o GitHub Team ou o GitHub Enterprise Cloud. GitHub Codespaces também está disponível como uma versão beta limitado para usuários individuais nos planos GitHub Free e GitHub Pro. Para obter mais informações, confira "produtos de GitHub".

Checking, changing, and deleting your prebuild configurations

The prebuilds that you configure for a repository are created and updated using a GitHub Actions workflow, managed by the GitHub Codespaces service.

Depending on the settings in a prebuild configuration, the workflow to update the prebuild may be triggered by these events:

  • Creating or updating the prebuild configuration
  • Pushing a commit or a pull request to a branch that's configured to have prebuilds
  • Changing any of the dev container configuration files
  • A schedule that you've defined in the prebuild configuration
  • Manually triggering the workflow

The settings in the prebuild configuration determine which events automatically trigger an update of the prebuild. For more information, see "Configuring prebuilds."

People with admin access to a repository can check the progress of prebuilds, edit, and delete prebuild configurations.

Viewing the progress of prebuilds

You can view the current status of the latest workflow run for each prebuild configuration you've set up on the GitHub Codespaces page of your repository settings. For example, "Currently running" or "Last run 1 hour ago."

To see the log output for the latest prebuild workflow run, click See output.

The 'See output' button

This displays the output of the most recent run of the workflow in the Actions tab.

The prebuild workflow output

Alternatively, to view all prebuild workflow runs associated with the specified branch, click the ellipsis button and choose View runs from the dropdown menu.

The 'View runs' option in the drop-down menu

This displays the workflow run history for prebuilds for the associated branch.

The workflow run history

Editing a prebuild configuration

  1. On the Codespaces page of your repository settings, click the ellipsis to the right of the prebuild configuration you want to edit.

  2. In the dropdown menu, click Edit.

    The 'Edit' option in the drop-down menu

  3. Make the required changes to the prebuild configuration, then click Update.

    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 no seu codespace".

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

    Captura de tela da página de autorização para pré-compilações

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

    Observação: os usuários que criam codespaces usando esse prebuild também deverão conceder essas permissões.

Disabling a prebuild configuration

To pause the update of prebuilds for a configuration, you can disable workflow runs for the configuration. Disabling the workflow runs for a prebuild configuration does not delete any previously created prebuilds for that configuration and, as a result, codespaces will continue to be generated from an existing prebuild.

Disabling the workflow runs for a prebuild configuration is useful if you need to investigate template creation failures.

  1. On the Codespaces page of your repository settings, click the ellipsis to the right of the prebuild configuration you want to disable.

  2. In the dropdown menu, click Disable runs.

    The 'Disable runs' option in the drop-down menu

  3. To confirm that you want to disable this configuration, click OK.

Deleting a prebuild configuration

Deleting a prebuild configuration also deletes all previously created prebuilds for that configuration. As a result, shortly after you delete a configuration, prebuilds generated by that configuration will no longer be available when you create a new codespace.

After you delete a prebuild configuration, workflow runs for that configuration that have been queued or started will still run. They will be listed in the workflow run history, along with previously completed workflow runs.

  1. On the Codespaces page of your repository settings, click the ellipsis to the right of the prebuild configuration you want to delete.

  2. In the dropdown menu, click Delete.

    The 'Delete' option in the drop-down menu

  3. Click OK to confirm the deletion.

Manually trigger prebuilds

It may be useful to manually trigger a workflow run for a prebuild configuration. Generally this is only necessary if you are debugging a problem with the workflow for a prebuild configuration.

  1. On the Codespaces page of your repository settings, click the ellipsis to the right of the prebuild configuration whose workflow you want to trigger.

  2. In the dropdown menu, click Manually trigger.

    The 'Manually trigger' option in the drop-down menu

Further reading