Skip to content

Commit b25be00

Browse files
hubwritergithub-actionslecoursen
authored
Add info about disabling Codespaces prebuilds (github#27362)
* Add info about disabling prebuilds * Optimize images * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/troubleshooting/troubleshooting-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> * Update content/codespaces/troubleshooting/troubleshooting-prebuilds.md Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: Laura Coursen <lecoursen@github.com>
1 parent db56eb2 commit b25be00

7 files changed

Lines changed: 18 additions & 1 deletion

File tree

9.73 KB
Loading
39 KB
Loading
-795 Bytes
Loading
-3.53 KB
Loading
-1.31 KB
Loading

content/codespaces/prebuilding-your-codespaces/managing-prebuilds.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,20 @@ This displays the workflow run history for prebuilds for the associated branch.
5858

5959
1. Make the required changes to the prebuild configuration, then click **Update**.
6060

61-
### Delete a prebuild configuration
61+
### Disabling a prebuild configuration
62+
63+
To pause the update of prebuild templates 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 prebuild templates for that configuration and, as a result, codespaces will continue to be generated from an existing prebuild template.
64+
65+
Disabling the workflow runs for a prebuild configuration is useful if you need to investigate template creation failures.
66+
67+
1. On the {% data variables.product.prodname_codespaces %} page of your repository settings, click the ellipsis to the right of the prebuild configuration you want to disable.
68+
1. In the dropdown menu, click **Disable runs**.
69+
70+
![The 'Disable runs' option in the drop-down menu](/assets/images/help/codespaces/prebuilds-disable.png)
71+
72+
1. To confirm that you want to disable this configuration, click **OK**.
73+
74+
### Deleting a prebuild configuration
6275

6376
Deleting a prebuild configuration also deletes all previously created prebuild templates 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.
6477

content/codespaces/troubleshooting/troubleshooting-prebuilds.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,10 @@ Here are things to check if the "{% octicon "zap" aria-label="The zap icon" %} P
5757
* Check whether a change to the dev container configuration was pushed to the prebuild-enabled branch recently. If so, you will typically have to wait until the prebuild workflow run for this push completes before prebuilds are available again.
5858
* If no configuration changes were recently made, go to the **Actions** tab of your repository, click **{% octicon "codespaces" aria-label="The Codespaces icon" %} {% data variables.product.prodname_codespaces %} Prebuilds** in the workflows list, and check that prebuild workflow runs for the branch are succeeding. If latest runs of a workflow failed, and one or more of these failed runs contained changes to the dev container configuration, then there will be no available prebuilds for the associated branch.
5959

60+
## Troubleshooting failed workflow runs for prebuilds
61+
62+
If the workflow runs for a prebuild configuration are failing, you can temporarily disable the prebuild configuration while you investigate. For more information, see "[Managing prebuilds](/codespaces/prebuilding-your-codespaces/managing-prebuilds#disabling-a-prebuild-configuration)."
63+
6064
## Further reading
6165

6266
- "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds)"

0 commit comments

Comments
 (0)