Accessibility: Replace Codespaces screenshots and rewrite alt text (#34864)
Co-authored-by: Laura Coursen <lecoursen@github.com>
This commit is contained in:
hubwriter
@@ -21,7 +21,7 @@ By default, whenever you push changes to your repository, {% data variables.prod
|
||||
|
||||
When prebuilds are available for a particular branch of a repository, a particular dev container configuration file, and for your region, you'll see the "{% octicon "zap" aria-label="The zap icon" %} Prebuild ready" label in the list of machine type options when you create a codespace. If a prebuild is still being created, you will see the "{% octicon "history" aria-label="The history icon" %} Prebuild in progress" label. For more information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository#creating-a-codespace-for-a-repository)."
|
||||
|
||||
|
||||
|
||||
|
||||
When you create a codespace from a template on the "Your codespaces" page, {% data variables.product.prodname_dotcom %} may automatically use a prebuild to speed up creation time. For more information on templates, see "[AUTOTITLE](/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template)."
|
||||
|
||||
|
||||
@@ -27,11 +27,11 @@ Prebuilds are created using {% data variables.product.prodname_actions %}. As a
|
||||
{% data reusables.codespaces.accessing-prebuild-configuration %}
|
||||
1. In the "Prebuild configuration" section of the page, click **Set up prebuild**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Choose the branch for which you want to set up prebuilds.
|
||||
|
||||
|
||||
|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -41,7 +41,7 @@ Prebuilds are created using {% data variables.product.prodname_actions %}. As a
|
||||
|
||||
1. Optionally, in the **Configuration file** dropdown menu that's displayed, choose the `devcontainer.json` configuration file that you want to use for your prebuilds. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#devcontainerjson)."
|
||||
|
||||
|
||||
|
||||
|
||||
1. Choose how you want to automatically trigger prebuild updates.
|
||||
|
||||
@@ -62,13 +62,13 @@ Prebuilds are created using {% data variables.product.prodname_actions %}. As a
|
||||
|
||||
- **Scheduled** - With this setting, you can have your prebuilds updated on a custom schedule that's defined by you. This can reduce consumption of {% data variables.product.prodname_actions %} minutes, however, with this option, codespaces may be created that do not use the latest dev container configuration changes.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Optionally, select **Reduce prebuild available to only specific regions** to create prebuilds only in specified regions. Select the regions in which you want prebuilds to be available.
|
||||
|
||||
By default, prebuilds are created in all of the available regions, incurring storage charges per prebuild.
|
||||
|
||||
|
||||
|
||||
|
||||
{% note %}
|
||||
|
||||
@@ -80,7 +80,7 @@ Prebuilds are created using {% data variables.product.prodname_actions %}. As a
|
||||
|
||||
1. Optionally, under **Template history**, set the number of prebuild versions to be retained. You can input any number between 1 and 5. The default number of saved versions is 2, which means that only the latest prebuild and the previous version are saved.
|
||||
|
||||
|
||||
|
||||
|
||||
Depending on your prebuild trigger settings, your prebuild could change with each push or on each dev container configuration change. Retaining older versions of prebuilds enables you to create a prebuild from an older commit with a different dev container configuration than the current prebuild. This setting allows you to set the number of retained versions to a level that is appropriate for your needs.
|
||||
|
||||
@@ -90,11 +90,11 @@ Prebuilds are created using {% data variables.product.prodname_actions %}. As a
|
||||
|
||||
1. Optionally, add users or teams to notify when the prebuild workflow run fails for this 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. The users or teams you add will receive an email when prebuild failures occur, containing a link to the workflow run logs to help with further investigation.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Optionally, at the bottom of the page, click **Show advanced options**.
|
||||
|
||||
|
||||
|
||||
|
||||
In the "Advanced options" section, if you select **Disable prebuild optimization**, codespaces will be created without a prebuild if the latest prebuild workflow has failed or is currently running. For more information, see "[AUTOTITLE](/codespaces/troubleshooting/troubleshooting-prebuilds#preventing-out-of-date-prebuilds-being-used)."
|
||||
|
||||
|
||||
@@ -12,7 +12,7 @@ topics:
|
||||
|
||||
## 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_github_codespaces %} service.
|
||||
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_github_codespaces %} service.
|
||||
|
||||
Depending on the settings in a prebuild configuration, the workflow to update the prebuild may be triggered by these events:
|
||||
|
||||
@@ -22,37 +22,37 @@ Depending on the settings in a prebuild configuration, the workflow to update th
|
||||
* 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. For more information, see "[AUTOTITLE](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-prebuilds)."
|
||||
The settings in the prebuild configuration determine which events automatically trigger an update of the prebuild. For more information, see "[AUTOTITLE](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-prebuilds)."
|
||||
|
||||
People with admin access to a repository can check the progress of prebuilds, edit, and delete prebuild configurations.
|
||||
People with admin access to a repository can check the progress of prebuilds, edit, and delete prebuild configurations.
|
||||
|
||||
### 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 {% data variables.product.prodname_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, click the ellipsis button and choose **View runs** from the dropdown menu.
|
||||
Alternatively, to view all prebuild workflow runs associated with the specified branch, select the {% octicon "kebab-horizontal" aria-label="options" %} dropdown menu and click **View runs**.
|
||||
|
||||
|
||||
|
||||
|
||||
This displays the workflow run history for prebuilds for the associated branch.
|
||||
|
||||
|
||||
|
||||
|
||||
### Editing a prebuild configuration
|
||||
|
||||
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 edit.
|
||||
1. In the dropdown menu, click **Edit**.
|
||||
|
||||
|
||||
|
||||
1. Make the required changes to the prebuild configuration, then click **Update**.
|
||||
|
||||
|
||||
1. Make the required changes to the prebuild configuration, then click **Update**.
|
||||
|
||||
{% data reusables.codespaces.prebuilds-permission-authorization %}
|
||||
|
||||
@@ -66,7 +66,7 @@ Disabling the workflow runs for a prebuild configuration is useful if you need t
|
||||
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.
|
||||
1. In the dropdown menu, click **Disable runs**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. To confirm that you want to disable this configuration, click **OK**.
|
||||
|
||||
@@ -79,7 +79,7 @@ After you delete a prebuild configuration, workflow runs for that configuration
|
||||
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 delete.
|
||||
1. In the dropdown menu, click **Delete**.
|
||||
|
||||
|
||||
|
||||
|
||||
1. Click **OK** to confirm the deletion.
|
||||
|
||||
@@ -90,7 +90,7 @@ It may be useful to manually trigger a workflow run for a prebuild configuration
|
||||
1. On the {% data variables.product.prodname_codespaces %} page of your repository settings, click the ellipsis to the right of the prebuild configuration whose workflow you want to trigger.
|
||||
1. In the dropdown menu, click **Manually trigger**.
|
||||
|
||||
|
||||
|
||||
|
||||
## Further reading
|
||||
|
||||
|
||||
Reference in New Issue
Block a user