Skip to content

Commit 194deca

Browse files
committed
Codespaces prebuilds GA + minor updates
1 parent b0ba758 commit 194deca

14 files changed

+16
-28
lines changed
67.5 KB
Loading
56.2 KB
Loading

content/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ If you purchased {% data variables.product.prodname_enterprise %} through a Micr
4242

4343
### Billing for {% data variables.product.prodname_codespaces %} prebuilds
4444

45-
{% data reusables.codespaces.prebuilds-beta-note %}
4645

4746
{% data reusables.codespaces.billing-for-prebuilds %}
4847

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: About Codespaces prebuilds
33
shortTitle: About prebuilds
4-
intro: Codespaces prebuilds help to speed up the creation of new codespaces.
4+
intro: Codespaces prebuilds help to speed up the creation of new codespaces for large or complex repositories.
55
versions:
66
fpt: '*'
77
ghec: '*'
@@ -10,11 +10,9 @@ topics:
1010
product: '{% data reusables.gated-features.codespaces %}'
1111
---
1212

13-
{% data reusables.codespaces.prebuilds-beta-note %}
14-
1513
## Overview
1614

17-
Prebuilding your codespaces allows you to be more productive and access your codespace faster, regardless of the size and complexity of your project. This is because any source code, editor extensions, project dependencies, commands, and configurations have already been downloaded, installed, and applied before you create a codespace for your project. Think of a prebuild as a "ready-to-go" template for a codespace.
15+
Prebuilding your codespaces allows you to be more productive and access your codespace faster, particularly if your repository is large or complex and new codespaces currently take more than 2 minutes to start. This is because any source code, editor extensions, project dependencies, commands, and configurations have already been downloaded, installed, and applied before you create a codespace for your project. Think of a prebuild as a "ready-to-go" template for a codespace.
1816

1917
By default, whenever you push changes to your repository, {% data variables.product.prodname_codespaces %} uses {% data variables.product.prodname_actions %} to automatically update your prebuilds.
2018

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

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ product: '{% data reusables.gated-features.codespaces %}'
1313
permissions: People with admin access to a repository can configure prebuilds for the repository.
1414
---
1515

16-
{% data reusables.codespaces.prebuilds-beta-note %}
17-
1816
You can set up a prebuild configuration for a specific branch of your repository.
1917

2018
Any branch created from a prebuild-enabled base branch will typically also get assigned a prebuild during codespace creation. This is true if the dev container on the branch is the same as on the base branch. This is because the majority of the prebuild configuration for branches with the same dev container configuration are identical, so developers can benefit from faster codespace creation times on those branches also. For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)."
@@ -68,6 +66,18 @@ Before you can configure prebuilds for your project the following must be true:
6866

6967
![The prebuild trigger options](/assets/images/help/codespaces/prebuilds-triggers.png)
7068

69+
1. Set the number of prebuild template versions to retain. You can input any number less than or equal to 5. The default number of versions saved is 5.
70+
71+
Retaining older versions of prebuild templates enables you to create a prebuild from an older commit with a different dev container configuration than the current prebuild template. This is useful because, depending on your trigger settings, your prebuild template could change with each push or on each dev container configuration change. Since there is a storage cost associated with retaining prebuild template versions, you can choose to change the number of versions to be retained, based on the needs of your team. For more information on billing for {% data variables.product.prodname_codespaces %}, see "[About billing for {% data variables.product.prodname_codespaces %}](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-codespaces#codespaces-pricing)."
72+
73+
If you set the number of prebuild template versions to save to 0, {% data variables.product.prodname_codespaces %} will delete the older version of the prebuild template each time it is updated, and you will not have a prebuilt codespace if you go back to an older dev container configuration.
74+
75+
![The prebuild template history setting](/assets/images/help/codespaces/codespaces-prebuilds-template-history-setting.png)
76+
77+
1. Add users or teams to notify when your prebuild workflow runs fail for this particular prefuild configuration. You can begin typing a username, team name, or full name, then click the name once it appears to add them to the list. Those you add will receive an email immediately after prebuild failures containing a link to the workflow run logs.
78+
79+
![The prebuild failure notification setting](/assets/images/help/codespaces/codespaces-prebuilds-failure-notification-setting.png)
80+
7181
1. Click **Create**.
7282

7383
The prebuild configuration is listed on the {% data variables.product.prodname_codespaces %} page of your repository settings. A {% data variables.product.prodname_actions %} workflow is queued and then run to create prebuild templates, based on the branch you selected, in the regions you specified.

content/codespaces/prebuilding-your-codespaces/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,5 +15,4 @@ children:
1515
- /managing-prebuilds
1616
- /testing-dev-container-changes
1717
---
18-
19-
{% data reusables.codespaces.prebuilds-beta-note %}
18+

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

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ product: '{% data reusables.gated-features.codespaces %}'
1212
miniTocMaxHeadingLevel: 3
1313
---
1414

15-
{% data reusables.codespaces.prebuilds-beta-note %}
16-
1715
## Checking, changing, and deleting your prebuild configurations
1816

1917
The prebuilds that you configure for a repository are created and updated using a {% data variables.product.prodname_actions %} workflow, managed by the {% data variables.product.prodname_codespaces %} service.

content/codespaces/prebuilding-your-codespaces/testing-dev-container-changes.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ product: '{% data reusables.gated-features.codespaces %}'
1414
permissions: People with write permissions to a repository can create or edit the dev container configuration for a branch.
1515
---
1616

17-
{% data reusables.codespaces.prebuilds-beta-note %}
18-
1917
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 template. 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.
2018

2119
For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)."

content/codespaces/troubleshooting/troubleshooting-prebuilds.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,6 @@ product: '{% data reusables.gated-features.codespaces %}'
1212
miniTocMaxHeadingLevel: 3
1313
---
1414

15-
{% data reusables.codespaces.prebuilds-beta-note %}
16-
1715
For more information about {% data variables.product.prodname_codespaces %} prebuilds, see "[Prebuilding your codespaces](/codespaces/prebuilding-your-codespaces)."
1816

1917
## Checking whether a codespace was created from a prebuild?

data/reusables/codespaces/about-billing-for-codespaces.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

0 commit comments

Comments
 (0)