Managing prebuilds - GitHub Docs
https://docs.github.com/en/codespaces/prebuilding-your-codespaces/managing-prebuilds • 194 KB fetched
Open original page
Managing prebuilds - GitHub Docs Skip to main content
GitHub Docs Version: Free, Pro, & Team
Search or ask Copilot Search or ask Copilot
Select language: current language is English
Search or ask Copilot Search or ask Copilot
Open menu
Collapse sidebar Expand sidebar
Scroll breadcrumbs left
* Home
* Codespaces
* Prebuilding your codespaces
* Manage prebuilds
Scroll breadcrumbs right
Codespaces
*
*
* Quickstart
* Getting started
* What are Codespaces?
* Codespaces features
* The codespace lifecycle
* Deep dive into Codespaces
* Developing in a codespace
* Develop in a codespace
* Create a codespace for a repo
* Create a codespace from a template
* Delete a codespace
* Open an existing codespace
* Work collaboratively
* Source control
* Pull requests
* Stop a codespace
* Forward ports
* Rebuilding a container
* Default environment variables
* Persist variables and files
* Connecting to a private network
* Machine learning
* Visual Studio Code
* GitHub CLI
* Customizing your codespace
* Rename a codespace
* Change your shell
* Change the machine type
* Setting your user preferences
* Personalize your codespaces
* Set the default editor
* Set the default region
* Set the timeout
* Configure automatic deletion
* Choose the host image
* Setting up your project
* Adding a dev container configuration
* Introduction to dev containers
* Setting up a Node.js project
* Setting up a C# (.NET) project
* Setting up a Java project
* Setting up a PHP project
* Setting up a Python project
* Configuring dev containers
* Set a minimum machine spec
* Adding features
* Automatically opening files
* Specifying recommended secrets
* Setting up your repository
* Facilitating codespace creation
* Set up a template repo
* Prebuilding your codespaces
* About prebuilds
* Configure prebuilds
* Allow external repo access
* Manage prebuilds
* Test dev container changes
* Managing your codespaces
* Codespaces secrets
* Repository access
* Security logs
* GPG verification
* Managing your organization
* Enable or disable Codespaces
* Billing and ownership
* List organization codespaces
* Manage Codespaces costs
* Manage secrets
* Audit logs
* Restrict machine types
* Restrict codespace creation
* Restrict base image
* Restrict port visibility
* Restrict timeout periods
* Restrict the retention period
* Reference
* Access a private registry
* Copilot in Codespaces
* VS Code Command Palette
* Security in Codespaces
* Disaster recovery
* Troubleshooting
* Codespaces logs
* Codespaces clients
* Included usage
* Exporting changes
* Creation and deletion
* Authenticating to repositories
* Connection
* Codespaces prebuilds
* Personalization
* Port forwarding
* GPG verification
* Working with support
* github.dev editor
Managing prebuilds
You can review, modify, and delete the prebuild configurations for your repository.
Who can use this feature?
Repository-level settings for GitHub Codespaces are available for all repositories owned by personal accounts.
For repositories owned by organizations, repository-level settings for GitHub Codespaces are available for organizations on GitHub Team and GitHub Enterprise plans. To access the settings, the organization or its parent enterprise must have added a payment method and set a spending limit for GitHub Codespaces. For more information, see Choosing who owns and pays for codespaces in your organization and GitHub's plans .
Copy as Markdown
In this article
* About managing prebuilds
* Viewing the progress of prebuilds
* Editing a prebuild configuration
* Disabling a prebuild configuration
* Deleting a prebuild configuration
* Manually trigger prebuilds
* Further reading
About managing prebuilds
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. See Configuring prebuilds .
People with admin access to a repository can check the progress of prebuilds, edit, and delete prebuild configurations.
To locate all repositories that are hosting a prebuild configuration, you must obtain a copy of your usage report by following the steps for Viewing your usage of metered products and licenses .
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 .
This displays the output of the most recent run of the workflow in the Actions tab.
Alternatively, to view all prebuild workflow runs associated with the specified branch, select the dropdown menu and click View runs .
This displays the workflow run history for prebuilds for the associated branch.
Editing a prebuild configuration
*
On the Codespaces page of your repository settings, click the ellipsis to the right of the prebuild configuration you want to edit.
*
In the dropdown menu, click Edit .
*
Make the required changes to the prebuild configuration, then click Update .
If the dev container configuration for the repository specifies permissions for accessing other repositories, you will be shown an authorization page. For more information on how this is specified in the devcontainer.json file, see Managing access to other repositories within your codespace .
Click to view the details of the requested permissions.
Click Authorize and continue to grant these permissions for creation of prebuilds. Alternatively, you can click Continue without authorizing but, if you do so, codespaces created from the resulting prebuilds may not work properly.
Note
Users who create codespaces using this prebuild will also be asked to grant these permissions.
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 prebuild creation failures.
*
On the Codespaces page of your repository settings, click the ellipsis to the right of the prebuild configuration you want to disable.
*
In the dropdown menu, click Disable runs .
*
To confirm that you want to disable this configuration, click OK .
Deleting a prebuild configuration
Note
You can find a list of the repositories that contain a prebuild by obtaining a copy of your “ usage report .”
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.
*
On the Codespaces page of your repository settings, click the ellipsis to the right of the prebuild configuration you want to delete.
*
In the dropdown menu, click Delete .
*
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.
*
On the Codespaces page of your repository settings, click the ellipsis to the right of the prebuild configuration whose workflow you want to trigger.
*
In the dropdown menu, click Manually trigger .
Further reading
* Troubleshooting prebuilds
Back to top
Help and support
Was this Doc helpful?
Yes No
Help us make GitHub Docs great!
All Docs are open source. See something that's wrong or unclear? Submit a pull request.
Make a contribution
Still need help?
Provide GitHub Feedback Contact support Expert services Blog
GitHub Inc. © 2026 Terms Privacy Status Pricing
Links found on this page
- Skip to main content [direct]
- GitHub Docs [direct]
- Codespaces [direct]
- Prebuilding your codespaces [direct]
- Quickstart [direct]
- What are Codespaces? [direct]
- Codespaces features [direct]
- The codespace lifecycle [direct]
- Deep dive into Codespaces [direct]
- Develop in a codespace [direct]
- Create a codespace for a repo [direct]
- Create a codespace from a template [direct]
- Delete a codespace [direct]
- Open an existing codespace [direct]
- Work collaboratively [direct]
- Source control [direct]
- Pull requests [direct]
- Stop a codespace [direct]
- Forward ports [direct]
- Rebuilding a container [direct]
- Default environment variables [direct]
- Persist variables and files [direct]
- Connecting to a private network [direct]
- Machine learning [direct]
- Visual Studio Code [direct]
- GitHub CLI [direct]
- Rename a codespace [direct]
- Change your shell [direct]
- Change the machine type [direct]
- Personalize your codespaces [direct]
- Set the default editor [direct]
- Set the default region [direct]
- Set the timeout [direct]
- Configure automatic deletion [direct]
- Choose the host image [direct]
- Introduction to dev containers [direct]
- Setting up a Node.js project [direct]
- Setting up a C# (.NET) project [direct]
- Setting up a Java project [direct]
- Setting up a PHP project [direct]
- Setting up a Python project [direct]
- Set a minimum machine spec [direct]
- Adding features [direct]
- Automatically opening files [direct]
- Specifying recommended secrets [direct]
- Facilitating codespace creation [direct]
- Set up a template repo [direct]
- About prebuilds [direct]
- Configure prebuilds [direct]
- Allow external repo access [direct]
- Test dev container changes [direct]
- Codespaces secrets [direct]
- Repository access [direct]
- Security logs [direct]
- GPG verification [direct]
- Enable or disable Codespaces [direct]
- Billing and ownership [direct]
- List organization codespaces [direct]
- Manage Codespaces costs [direct]
- Manage secrets [direct]
- Audit logs [direct]
- Restrict machine types [direct]
- Restrict codespace creation [direct]
- Restrict base image [direct]
- Restrict port visibility [direct]
- Restrict timeout periods [direct]
- Restrict the retention period [direct]
- Access a private registry [direct]
- Copilot in Codespaces [direct]
- VS Code Command Palette [direct]
- Security in Codespaces [direct]
- Disaster recovery [direct]
- Codespaces logs [direct]
- Codespaces clients [direct]
- Included usage [direct]
- Exporting changes [direct]
- Creation and deletion [direct]
- Authenticating to repositories [direct]
- Connection [direct]
- Codespaces prebuilds [direct]