Skip to main content

Testing dev container configuration changes on a prebuild-enabled branch

When you change the dev container configuration for a branch that's enabled for prebuilds you should test your changes in a codespace.

Who can use this feature

People with write permissions to a repository can create or edit the dev container configuration for a branch.

GitHub Codespaces is available for organizations using GitHub Team or GitHub Enterprise Cloud. GitHub Codespaces is also available as a limited beta release for individual users on GitHub Free and GitHub Pro plans. For more information, see "GitHub's products."

Any changes you make to the dev container configuration for a prebuild-enabled branch will result in an update to the codespace configuration and the associated prebuild. It’s therefore important to test such changes in a codespace from a test branch before committing your changes to a branch of your repository that's actively used. This will ensure you’re not introducing breaking changes for your team.

For more information, see "Introduction to dev containers."

Testing changes to the dev container configuration

  1. Create a codespace from the prebuild-enabled branch whose dev container you want to change. For more information, see "Creating a codespace ."

  2. In the codespace, check out a test branch. For more information, see "Using source control in your codespace."

  3. Make the required changes to the dev container configuration.

  4. Apply the changes by rebuilding the container. For more information, see "Introduction to dev containers."

  5. After everything looks good, we also recommend creating a new codespace from your test branch to ensure everything is working. You can then commit your changes to your repository's default branch, or an active feature branch, triggering an update of the prebuild for that branch.

    Note: Creating this codespace will take longer than usual because it will not be created from a prebuild.