1
0
mirror of synced 2025-12-21 02:46:50 -05:00

Codespaces prebuilds GA + minor updates

This commit is contained in:
Sarita Iyer
2022-06-08 09:28:31 -04:00
parent b0ba7588d8
commit 194deca9db
14 changed files with 16 additions and 28 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

View File

@@ -42,7 +42,6 @@ If you purchased {% data variables.product.prodname_enterprise %} through a Micr
### Billing for {% data variables.product.prodname_codespaces %} prebuilds
{% data reusables.codespaces.prebuilds-beta-note %}
{% data reusables.codespaces.billing-for-prebuilds %}

View File

@@ -1,7 +1,7 @@
---
title: About Codespaces prebuilds
shortTitle: About prebuilds
intro: Codespaces prebuilds help to speed up the creation of new codespaces.
intro: Codespaces prebuilds help to speed up the creation of new codespaces for large or complex repositories.
versions:
fpt: '*'
ghec: '*'
@@ -10,11 +10,9 @@ topics:
product: '{% data reusables.gated-features.codespaces %}'
---
{% data reusables.codespaces.prebuilds-beta-note %}
## Overview
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.
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.
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.

View File

@@ -13,8 +13,6 @@ product: '{% data reusables.gated-features.codespaces %}'
permissions: People with admin access to a repository can configure prebuilds for the repository.
---
{% data reusables.codespaces.prebuilds-beta-note %}
You can set up a prebuild configuration for a specific branch of your repository.
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:
![The prebuild trigger options](/assets/images/help/codespaces/prebuilds-triggers.png)
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.
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)."
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.
![The prebuild template history setting](/assets/images/help/codespaces/codespaces-prebuilds-template-history-setting.png)
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.
![The prebuild failure notification setting](/assets/images/help/codespaces/codespaces-prebuilds-failure-notification-setting.png)
1. Click **Create**.
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.

View File

@@ -16,4 +16,3 @@ children:
- /testing-dev-container-changes
---
{% data reusables.codespaces.prebuilds-beta-note %}

View File

@@ -12,8 +12,6 @@ product: '{% data reusables.gated-features.codespaces %}'
miniTocMaxHeadingLevel: 3
---
{% data reusables.codespaces.prebuilds-beta-note %}
## Checking, changing, and deleting your prebuild configurations
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.

View File

@@ -14,8 +14,6 @@ product: '{% data reusables.gated-features.codespaces %}'
permissions: People with write permissions to a repository can create or edit the dev container configuration for a branch.
---
{% data reusables.codespaces.prebuilds-beta-note %}
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. Its 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 youre not introducing breaking changes for your team.
For more information, see "[Introduction to dev containers](/codespaces/setting-up-your-project-for-codespaces/introduction-to-dev-containers)."

View File

@@ -12,8 +12,6 @@ product: '{% data reusables.gated-features.codespaces %}'
miniTocMaxHeadingLevel: 3
---
{% data reusables.codespaces.prebuilds-beta-note %}
For more information about {% data variables.product.prodname_codespaces %} prebuilds, see "[Prebuilding your codespaces](/codespaces/prebuilding-your-codespaces)."
## Checking whether a codespace was created from a prebuild?

View File

@@ -1 +0,0 @@
{% data variables.product.prodname_codespaces %} is free to use during the beta. When {% data variables.product.prodname_codespaces %} becomes generally available, you will be billed for storage and compute usage.

View File

@@ -1,5 +0,0 @@
During the beta, functionality is limited.
- {% data reusables.codespaces.use-chrome %}
- Only a single size of codespace is available.
- Only Linux containers are supported.
- A codespace is not fully resumable. Processes that were running at the time the codespace was stopped will not be restarted.

View File

@@ -4,4 +4,4 @@ If you are an organization owner, you can track usage of prebuild workflows by d
To reduce consumption of Actions minutes, you can set a prebuild template to be updated only when you make a change to your dev container configuration files, or only on a custom schedule. For more information, see "[Configuring prebuilds](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-a-prebuild)."
While {% data variables.product.prodname_codespaces %} prebuilds is in beta there is no charge for storage of templates. When prebuilds become generally available, you will be billed for storing prebuild templates for each prebuild configuration in each region selected for that configuration.
Storage of prebuild templates is billed at the same rate as storage of codespaces.

View File

@@ -1,5 +0,0 @@
{% note %}
**Note:** The ability to prebuild codespaces is currently in beta and subject to change.
{% endnote %}

View File

@@ -1 +0,0 @@
During the beta, private repositories owned by organizations or any repositories owned by an organization that requires SAML single sign-on are not supported.