diff --git a/assets/images/help/codespaces/host-image-choice.png b/assets/images/help/codespaces/host-image-choice.png new file mode 100644 index 000000000000..2f2b66901efd Binary files /dev/null and b/assets/images/help/codespaces/host-image-choice.png differ diff --git a/content/admin/guides.md b/content/admin/guides.md index 1cf15e57b0f0..9af7e095fe17 100644 --- a/content/admin/guides.md +++ b/content/admin/guides.md @@ -26,7 +26,6 @@ includeGuides: - /admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise - /admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-user-provisioning-with-scim-for-your-enterprise - /admin/identity-and-access-management/understanding-iam-for-enterprises/about-saml-for-enterprise-iam - - /admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise - /admin/identity-and-access-management/using-saml-for-enterprise-iam/configuring-saml-single-sign-on-for-your-enterprise-using-okta - /admin/identity-and-access-management/using-saml-for-enterprise-iam/managing-team-synchronization-for-organizations-in-your-enterprise - /admin/identity-and-access-management/using-saml-for-enterprise-iam/switching-your-saml-configuration-from-an-organization-to-an-enterprise-account @@ -97,7 +96,6 @@ includeGuides: - /admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-environment - /admin/policies/enforcing-policy-with-pre-receive-hooks/creating-a-pre-receive-hook-script - /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-code-security-and-analysis-for-your-enterprise - - /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-github-actions-in-your-enterprise - /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-security-settings-in-your-enterprise - /admin/policies/enforcing-policies-for-your-enterprise/enforcing-policies-for-projects-in-your-enterprise - /admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise @@ -143,4 +141,3 @@ includeGuides: - /admin/administering-your-instance/administering-your-instance-from-the-web-ui/accessing-the-management-console - /admin/administering-your-instance/administering-your-instance-from-the-web-ui/troubleshooting-access-to-the-management-console --- - diff --git a/content/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md b/content/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md index e603aa7c023c..faa6202d2ca7 100644 --- a/content/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md +++ b/content/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces.md @@ -110,7 +110,7 @@ The compute usage of a codespace is the length of time for which that codespace As an example, if a codespace is active for 1 hour and 15 minutes, then the compute cost will be the hourly cost of the codespace, as determined by its machine type, multiplied by 1.25. -You can control compute usage by stopping your codespaces. For information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace)." Codespaces are stopped automatically after a configurable period of inactivity. The timeout period can be configured by the user, or at the organization level. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)" and "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period)." +You can control compute usage by stopping your codespaces. For information, see "[AUTOTITLE](/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace)." Codespaces are stopped automatically after a configurable period of inactivity. The timeout period can be configured by the user, or at the organization level. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces)" and "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period)." ## About billing for storage usage diff --git a/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md b/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md index 3895f04b14d6..506bde644b96 100644 --- a/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md +++ b/content/codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace.md @@ -104,5 +104,7 @@ You can use the `gh codespace edit --machine MACHINE-TYPE-NAME` {% data variable - "[AUTOTITLE](/rest/codespaces/machines)" in the REST API documentation - [`gh codespace edit`](https://cli.github.com/manual/gh_codespace_edit) in the {% data variables.product.prodname_cli %} manual +- "[AUTOTITLE](/codespaces/setting-your-user-preferences)" +- "[AUTOTITLE](/codespaces/managing-your-codespaces)" {% endcli %} diff --git a/content/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md b/content/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md index 7cc93b77190f..d3cd17b7a728 100644 --- a/content/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md +++ b/content/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md @@ -12,7 +12,7 @@ type: how_to When you're working in a codespace, you can open a new terminal window with a shell of your choice, change your default shell for new terminal windows, or install a new shell. You can also use dotfiles to configure your shell. -Codespaces that use the default codespace image come with the `bash`, `zsh`, and `fish` shells installed. If you open a new codespace in the {% data variables.product.prodname_vscode_shortname %} web client, or connect to a codespace over SSH, the terminal opens with a `bash` session running by default. In the {% data variables.product.prodname_vscode_shortname %} desktop application, the default shell depends on your local settings and operating system. For more information, see [Terminal Profiles](https://code.visualstudio.com/docs/terminal/profiles) in the {% data variables.product.prodname_vscode_shortname %} documentation. +Codespaces that use the default dev container image come with the `bash`, `zsh`, and `fish` shells installed. If you open a new codespace in the {% data variables.product.prodname_vscode_shortname %} web client, or connect to a codespace over SSH, the terminal opens with a `bash` session running by default. In the {% data variables.product.prodname_vscode_shortname %} desktop application, the default shell depends on your local settings and operating system. For more information, see [Terminal Profiles](https://code.visualstudio.com/docs/terminal/profiles) in the {% data variables.product.prodname_vscode_shortname %} documentation. ## Changing from the default shell in {% data variables.product.prodname_vscode_shortname %} @@ -29,9 +29,9 @@ If you don't want to use the default shell, you can open a new terminal session If you want to use a shell that isn't already installed in the base image or dev container configuration for a codespace, you can install a new shell. -If you're using the default codespace image, look for installation instructions for Ubuntu Linux. If you just want to use a different shell for one session, you can use the command line to install the shell in the codespace you're working in. However, you may lose programs you have installed if you rebuild the container in the codespace. For more information, see "[AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace)." +If you're using the default dev container image, look for installation instructions for Ubuntu Linux. If you just want to use a different shell for one session, you can use the command line to install the shell in the codespace you're working in. However, you may lose programs you have installed if you rebuild the container in the codespace. For more information, see "[AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace)." -A more robust option for installing new shells is to include the installation commands either in a dotfiles repository, or as a lifecycle command such as `postCreateCommand` in a `devcontainer.json` file. You should use a dotfiles repository to install a shell you want to use in all your own codespaces, and a `devcontainer.json` file for a shell that contributors to a specific repository should have installed. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)" and "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." +A more robust option for installing new shells is to include the installation commands either in a dotfiles repository, or as a lifecycle command such as `postCreateCommand` in a `devcontainer.json` file. You should use a dotfiles repository to install a shell you want to use in all your own codespaces, and a `devcontainer.json` file for a shell that contributors to a specific repository should have installed. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles)" and "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." ### Adding a {% data variables.product.prodname_vscode_shortname %} terminal profile for a new shell @@ -99,7 +99,7 @@ You can set a default terminal profile to choose the default shell used for all When you connect to a codespace from the command line over SSH, you connect to a `bash` session in the codespace by default. -If you have enabled a dotfiles repository for {% data variables.product.prodname_github_codespaces %}, you can change the default shell you connect to by adding a command to an installation script such as `install.sh` in your dotfiles. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli#ssh-into-a-codespace)" and "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." For example, the following command changes the default shell to `zsh`. +If you have enabled a dotfiles repository for {% data variables.product.prodname_github_codespaces %}, you can change the default shell you connect to by adding a command to an installation script such as `install.sh` in your dotfiles. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli#ssh-into-a-codespace)" and "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles)." For example, the following command changes the default shell to `zsh`. ```shell copy sudo chsh "$(id -un)" --shell "/usr/bin/zsh" @@ -127,7 +127,7 @@ With most shells, you have the option of using a configuration file, such as `.b By default, codespaces contain predefined configuration for the shells that come preinstalled. For example, the home directory in a codespace contains `.bashrc` and `.zshrc` files. You can change the contents of these files then use a command like `source ~/.bashrc` to update your shell configuration. However, you will lose any changes to these files if you rebuild the container in a codespace. For more information, see "[AUTOTITLE](/codespaces/getting-started/deep-dive#about-the-directory-structure-of-a-codespace)." -Generally, you should use a dotfiles repository to configure shells with your preferred settings. The setup in your dotfiles applies to all codespaces you create, and persists over rebuilds of the container. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." +Generally, you should use a dotfiles repository to configure shells with your preferred settings. The setup in your dotfiles applies to all codespaces you create, and persists over rebuilds of the container. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles)." ### Troubleshooting the `fish` shell @@ -156,3 +156,8 @@ To access the web-based interface for `fish_config`:

Start the Fish Web config

``` + +## Further reading + +- "[AUTOTITLE](/codespaces/setting-your-user-preferences)" +- "[AUTOTITLE](/codespaces/managing-your-codespaces)" diff --git a/content/codespaces/customizing-your-codespace/index.md b/content/codespaces/customizing-your-codespace/index.md index c0ab06394135..44cfccb32bc5 100644 --- a/content/codespaces/customizing-your-codespace/index.md +++ b/content/codespaces/customizing-your-codespace/index.md @@ -1,6 +1,6 @@ --- title: Customizing your codespace -intro: '{% data variables.product.prodname_github_codespaces %} is a dedicated environment for you. You can configure your repositories with a dev container to define their default {% data variables.product.prodname_github_codespaces %} environment, and personalize your development experience across all of your codespaces with dotfiles and Settings Sync.' +intro: 'You can customize a codespace you''ve created to suit your own preferences.' versions: fpt: '*' ghec: '*' @@ -9,13 +9,7 @@ redirect_from: topics: - Codespaces children: - - /personalizing-github-codespaces-for-your-account - /renaming-a-codespace - /changing-the-shell-in-a-codespace - /changing-the-machine-type-for-your-codespace - - /setting-your-default-editor-for-github-codespaces - - /setting-your-default-region-for-github-codespaces - - /setting-your-timeout-period-for-github-codespaces - - /configuring-automatic-deletion-of-your-codespaces --- - diff --git a/content/codespaces/customizing-your-codespace/renaming-a-codespace.md b/content/codespaces/customizing-your-codespace/renaming-a-codespace.md index 9f635820afca..2efffe628c00 100644 --- a/content/codespaces/customizing-your-codespace/renaming-a-codespace.md +++ b/content/codespaces/customizing-your-codespace/renaming-a-codespace.md @@ -76,3 +76,8 @@ You can change the display name for your codespace on {% data variables.product. 1. In the prompt, under "Change display name to..." type your desired display name and click **OK**. {% endwebui %} + +## Further reading + +- "[AUTOTITLE](/codespaces/setting-your-user-preferences)" +- "[AUTOTITLE](/codespaces/managing-your-codespaces)" diff --git a/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md b/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md index eb88d7696298..4d9a4dc9944a 100644 --- a/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md +++ b/content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md @@ -60,7 +60,7 @@ For more information on what happens when you create a codespace, see "[AUTOTITL For more information on the lifecycle of a codespace, see "[AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)." -If you want to use Git hooks for your codespace, then you should set up hooks using the `devcontainer.json` lifecycle scripts, such as `postCreateCommand`. These get executed during step 4, above. For information about the lifecycle scripts, see the [dev containers specification](https://containers.dev/implementors/json_reference/#lifecycle-scripts) on the Development Containers website. Since your codespace container is created after the repository is cloned, any [git template directory](https://git-scm.com/docs/git-init#_template_directory) configured in the container image will not apply to your codespace. Hooks must instead be installed after the codespace is created. +If you want to use Git hooks for your codespace, then you should set up hooks using the `devcontainer.json` lifecycle scripts, such as `postCreateCommand`. These get executed during step 4, above. For information about the lifecycle scripts, see the [dev containers specification](https://containers.dev/implementors/json_reference/#lifecycle-scripts) on the Development Containers website. Since the dev container for your codespace is created after the repository is cloned, any [git template directory](https://git-scm.com/docs/git-init#_template_directory) configured in the dev container image will not apply to your codespace. Hooks must instead be installed after the codespace is created. {% data reusables.codespaces.use-visual-studio-features %} diff --git a/content/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template.md b/content/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template.md index 3394cea846f1..3d6dc2b4aa12 100644 --- a/content/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template.md +++ b/content/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template.md @@ -28,7 +28,7 @@ You can start from a blank template, choose from templates maintained by {% data {% endnote %} {% endif %} -With a blank template, you'll start with an empty directory, with access to cloud-based compute resources and the tools, languages, and runtime environments that come preinstalled with the default codespace image. With other templates, you'll get starter files for the technology you're working with, plus typically some extra files such as a README file, a `.gitignore` file, and dev container configuration files containing some custom environment configuration. For more information on dev containers and the default image, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." +With a blank template, you'll start with an empty directory, with access to cloud-based compute resources and the tools, languages, and runtime environments that come preinstalled with the default dev container image. With other templates, you'll get starter files for the technology you're working with, plus typically some extra files such as a README file, a `.gitignore` file, and dev container configuration files containing some custom environment configuration. For more information on dev containers and the default image, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." As an example, if you create a codespace from {% data variables.product.company_short %}'s React template, you'll arrive in a workspace containing template files for a simple application, such as `index.js`, `app.js`, and `package.json`. Shortly after the codespace opens, a development server will start up automatically, and you will be able to view the running application in a simple browser tab within the {% data variables.product.prodname_vscode_shortname %} web client. diff --git a/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md b/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md index c165dbbe3201..60cbe97278e7 100644 --- a/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md +++ b/content/codespaces/developing-in-a-codespace/deleting-a-codespace.md @@ -18,7 +18,7 @@ shortTitle: Delete a codespace ## Overview -{% data reusables.codespaces.automatic-deletion %} For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces?tool=webui)." +{% data reusables.codespaces.automatic-deletion %} For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces?tool=webui)." You can manually delete a codespace in a variety of ways: - In the terminal by using {% data variables.product.prodname_cli %} @@ -148,5 +148,5 @@ You can also use the REST API to delete codespaces for your organization. For mo ## Further reading - "[AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle)" -- "[AUTOTITLE](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)" +- "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces)" - "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)" diff --git a/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md b/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md index 9f908f992150..7cc668b8e004 100644 --- a/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md +++ b/content/codespaces/developing-in-a-codespace/developing-in-a-codespace.md @@ -107,7 +107,7 @@ You can customize the codespaces that are created for a repository by creating o ### Personalizing your codespace -You can use a [dotfiles](https://dotfiles.github.io/tutorials/) repository to personalize aspects of the codespace environment for any codespace that you create. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." +You can use a [dotfiles](https://dotfiles.github.io/tutorials/) repository to personalize aspects of the codespace environment for any codespace that you create. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles)." ### Committing your changes diff --git a/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md b/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md index 0aa183818ce2..832a51ad5010 100644 --- a/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md +++ b/content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md @@ -28,7 +28,7 @@ You can view all your codespaces on the "Your codespaces" page at [github.com/co - See who owns (and may be billed for) your codespaces: your personal account, or organizations you belong to. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)." - See the machine type, size, and status of your codespaces. - Create a new codespace, either by choosing one of {% data variables.product.company_short %}'s templates or by clicking **New codespace**. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template)" and "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository)." -- Prevent automatic deletion of a codespace. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces?tool=webui#avoiding-automatic-deletion-of-codespaces)." +- Prevent automatic deletion of a codespace. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces?tool=webui#avoiding-automatic-deletion-of-codespaces)." {% webui %} @@ -57,7 +57,7 @@ You can bookmark the address of this page if you want to get back to it quickly ## Opening an existing codespace from the "Your codespaces" page {% data reusables.codespaces.your-codespaces-procedure-step %} -1. To open a codespace in your default editor, click the name of the codespace. {% data reusables.codespaces.about-changing-default-editor %} For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)." +1. To open a codespace in your default editor, click the name of the codespace. {% data reusables.codespaces.about-changing-default-editor %} For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces)." To open the codespace in an editor other than your default: diff --git a/content/codespaces/developing-in-a-codespace/persisting-environment-variables-and-temporary-files.md b/content/codespaces/developing-in-a-codespace/persisting-environment-variables-and-temporary-files.md index e17c930cb31e..bc2fc4783430 100644 --- a/content/codespaces/developing-in-a-codespace/persisting-environment-variables-and-temporary-files.md +++ b/content/codespaces/developing-in-a-codespace/persisting-environment-variables-and-temporary-files.md @@ -70,13 +70,13 @@ This setting will take effect the next time you create a codespace for this repo ### For all codespaces that you create -If you want to set a personalized environment variable for all codespaces that you create you can set this using a file in your `dotfiles` repository. For example, add `VARNAME=value` in the `.bash_profile` file. Environment variables you set in a dotfile are personal to you and are not set for anyone else. For more information about Dotfiles, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." +If you want to set a personalized environment variable for all codespaces that you create you can set this using a file in your `dotfiles` repository. For example, add `VARNAME=value` in the `.bash_profile` file. Environment variables you set in a dotfile are personal to you and are not set for anyone else. For more information about Dotfiles, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles)." ## Preventing temporary files from being automatically deleted {% data reusables.codespaces.workspaces-directory %} For information about creating symlinks to preserve data outside the `/workspaces` directory, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/rebuilding-the-container-in-a-codespace#persisting-data-over-a-rebuild)." -The `/tmp` directory is an exception because it is mounted into the container, but it is not persistent. Therefore, the contents of the `/tmp` directory are persisted over a rebuild, but are cleared each time the codespace stops. For example, the `/tmp` directory is cleared when a codespace session times out after a period of inactivity. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." +The `/tmp` directory is an exception because it is mounted into the container, but it is not persistent. Therefore, the contents of the `/tmp` directory are persisted over a rebuild, but are cleared each time the codespace stops. For example, the `/tmp` directory is cleared when a codespace session times out after a period of inactivity. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces)." If you have temporary files that you want to be available the next time you start the codespace, do not save them in the `/tmp` directory. diff --git a/content/codespaces/developing-in-a-codespace/rebuilding-the-container-in-a-codespace.md b/content/codespaces/developing-in-a-codespace/rebuilding-the-container-in-a-codespace.md index b079757d8ed9..962c5ccfb85a 100644 --- a/content/codespaces/developing-in-a-codespace/rebuilding-the-container-in-a-codespace.md +++ b/content/codespaces/developing-in-a-codespace/rebuilding-the-container-in-a-codespace.md @@ -1,6 +1,6 @@ --- title: Rebuilding the container in a codespace -intro: 'You can rebuild a container to apply configuration changes to the codespaces you are working in. From time to time, you may want to perform a full rebuild.' +intro: 'You can rebuild the dev container of a codespace you are working in to apply configuration changes. From time to time, you may want to perform a full rebuild.' versions: fpt: '*' ghec: '*' @@ -13,11 +13,11 @@ redirect_from: - /codespaces/developing-in-codespaces/rebuilding-the-container-in-a-codespace --- -## About rebuilding a container +## About rebuilding the dev container When you work in a codespace, your development environment is a Docker container that runs on a virtual machine. If you make changes to your dev container configuration from within a codespace, and you want to apply those changes to the current codespace, you need to rebuild the container. -By default, when you rebuild a container, {% data variables.product.prodname_github_codespaces %} will speed up the build process by reusing cached images from previous builds of the container. This is usually the quickest way to implement changes to your dev container configuration, for the following reasons. +By default, when you rebuild the dev container, {% data variables.product.prodname_github_codespaces %} will speed up the build process by reusing cached images from previous builds of the container. This is usually the quickest way to implement changes to your dev container configuration, for the following reasons. - {% data variables.product.prodname_github_codespaces %} can reuse images in your cache rather than repulling them from container registries. - The parts of your dev container configuration that define how the container is built, such as dev container features and Dockerfile instructions, may have already been implemented in image layers in your cache, so you won't need to wait for these processes to run again. (However, commands in your configuration that run after the container is built, such as `onCreateCommand`, will run again.) diff --git a/content/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code.md b/content/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code.md index 52261c16d103..9baf2a189e5f 100644 --- a/content/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code.md +++ b/content/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code.md @@ -22,9 +22,9 @@ topics: You can use your local install of {% data variables.product.prodname_vscode %} to create, manage, work in, and delete codespaces. {% data reusables.codespaces.using-codespaces-in-vscode %} For more information on setting up {% data variables.product.prodname_github_codespaces %} in {% data variables.product.prodname_vscode_shortname %}, see "[Prerequisites](#prerequisites)." -By default, if you create a new codespace on {% data variables.product.prodname_dotcom_the_website %}, it will open in the browser. If you would prefer to open any new codespaces in {% data variables.product.prodname_vscode_shortname %} automatically, you can set your default editor to be {% data variables.product.prodname_vscode_shortname %}. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)." +By default, if you create a new codespace on {% data variables.product.prodname_dotcom_the_website %}, it will open in the browser. If you would prefer to open any new codespaces in {% data variables.product.prodname_vscode_shortname %} automatically, you can set your default editor to be {% data variables.product.prodname_vscode_shortname %}. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces)." -If you prefer to work in the browser, but want to continue using your existing {% data variables.product.prodname_vscode_shortname %} extensions, themes, and shortcuts, you can turn on Settings Sync. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#settings-sync)." +If you prefer to work in the browser, but want to continue using your existing {% data variables.product.prodname_vscode_shortname %} extensions, themes, and shortcuts, you can turn on Settings Sync. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#settings-sync)." ## Prerequisites diff --git a/content/codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace.md b/content/codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace.md index cf135a327c5e..5dc908a2cda3 100644 --- a/content/codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace.md +++ b/content/codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace.md @@ -57,7 +57,7 @@ To stop sharing your codespace, click the stop icon in the Live Share panel. If you, as the person who started the Live Share session, close the codespace the sharing session ends, even if the codespace remains active on the remote host. -The idle timeout, which automatically stops a codespace after a period of inactivity, only applies to the person who started the codespace. It does not apply to people who are working on the codespace via Live Share. The codespace may therefore time out while collaborators are using the codespace if the person who started the codespace remains inactive for the configured period of time. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." +The idle timeout, which automatically stops a codespace after a period of inactivity, only applies to the person who started the codespace. It does not apply to people who are working on the codespace via Live Share. The codespace may therefore time out while collaborators are using the codespace if the person who started the codespace remains inactive for the configured period of time. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces)." ## Working collaboratively in someone else's codespace diff --git a/content/codespaces/getting-started/deep-dive.md b/content/codespaces/getting-started/deep-dive.md index 626db9b19216..e0ee174389ba 100644 --- a/content/codespaces/getting-started/deep-dive.md +++ b/content/codespaces/getting-started/deep-dive.md @@ -40,13 +40,13 @@ When you create a codespace, various steps happen in the background before the c ### Step 1: VM and storage are assigned to your codespace -When you create a codespace, a [shallow clone](https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/) is made of your repository, or of the template repository if you're creating a codespace from a template. The repository is cloned to a Linux virtual machine that is both dedicated and private to you. Having a dedicated VM ensures that you have the entire set of compute resources from that machine available to you. If necessary, this also allows you to have full root access to your container. +When you create a codespace, a virtual machine (VM) is created using either the stable or beta release of the VM host image. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/choosing-the-stable-or-beta-host-image)." The host image defines the version of Linux that is used for the VM. The VM is both dedicated and private to you. Having a dedicated VM ensures that you have the entire set of compute resources from that machine available to you. If necessary, this also allows you to have full root access to your container. -Your repository is cloned into the `/workspaces` directory in the codespace. For more information, see "[About the directory structure of a codespace](#about-the-directory-structure-of-a-codespace)" below. +A [shallow clone](https://github.blog/2020-12-21-get-up-to-speed-with-partial-clone-and-shallow-clone/) is then made of your repository, or of the template repository if you're creating a codespace from a template. This is cloned into the `/workspaces` directory of the VM and subsequently mounted into the dev container. For more information, see "[About the directory structure of a codespace](#about-the-directory-structure-of-a-codespace)" below. -### Step 2: Container is created +### Step 2: Dev container is created -{% data variables.product.prodname_github_codespaces %} uses a container as the development environment. This container is created based on configurations that you can define in a `devcontainer.json` file and, optionally, a Dockerfile. If you create a codespace from {% data variables.product.company_short %}'s blank template, or from a repository with no `devcontainer.json` file, {% data variables.product.prodname_github_codespaces %} uses a default image, which has many languages and runtimes available. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." For details of what the default image contains, see the [`devcontainers/images`](https://github.com/devcontainers/images/tree/main/src/universal) repository. +{% data variables.product.prodname_github_codespaces %} uses a Docker container as the development environment. This container is created based on configurations that you can define in a `devcontainer.json` file and, optionally, a Dockerfile. If you create a codespace from {% data variables.product.company_short %}'s blank template, or from a repository with no `devcontainer.json` file, {% data variables.product.prodname_github_codespaces %} uses a default image, which has many languages and runtimes available. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." For details of what the default image for dev containers includes, see the [`devcontainers/images`](https://github.com/devcontainers/images/tree/main/src/universal) repository. {% note %} @@ -71,7 +71,7 @@ Once you are connected to your codespace, your automated setup may continue to b If you want to use Git hooks in your codespace, set up hooks using the `devcontainer.json` lifecycle scripts, such as `postCreateCommand`. For information about the lifecycle scripts, see the [dev containers specification](https://containers.dev/implementors/json_reference/#lifecycle-scripts) on the Development Containers website. -If you have a public dotfiles repository for {% data variables.product.prodname_github_codespaces %}, you can enable it for use with new codespaces. When enabled, your dotfiles will be cloned to the container and the install script will be invoked. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." +If you have a public dotfiles repository for {% data variables.product.prodname_github_codespaces %}, you can enable it for use with new codespaces. When enabled, your dotfiles will be cloned to the container and the install script will be invoked. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles)." Finally, if you created the codespace from a repository, the entire history of the repository is copied down with a full clone. If you created the codespace from a template, the full history of the template repository is not preserved; instead, unless you are using the blank template, you will start with an initial commit for the contents of the template repository. @@ -87,7 +87,7 @@ If you work on codespaces in {% data variables.product.prodname_vscode %}, you c ### Closing or stopping your codespace -Your codespace will keep running while you are using it, but will time out after a period of inactivity. File changes from the editor and terminal output are counted as activity, so your codespace will not time out if terminal output is continuing. The default inactivity timeout period is 30 minutes. You can define your personal timeout setting for codespaces you create, but this may be overruled by an organization timeout policy. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." +Your codespace will keep running while you are using it, but will time out after a period of inactivity. File changes from the editor and terminal output are counted as activity, so your codespace will not time out if terminal output is continuing. The default inactivity timeout period is 30 minutes. You can define your personal timeout setting for codespaces you create, but this may be overruled by an organization timeout policy. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces)." If a codespace times out it will stop running, but you can restart it from the browser tab (if you were using the codespace in the browser), from within {% data variables.product.prodname_vscode_shortname %}, or from your list of codespaces at [https://github.com/codespaces](https://github.com/codespaces). @@ -165,7 +165,7 @@ Clearing the directories outside `/workspaces` helps to ensure the rebuilt conta If you want to make changes to your codespace that will be more robust over rebuilds and across different codespaces, you have several options. - To install programs and tools in all codespaces created from a repository, in your dev container configuration, you can use lifecycle command properties such as `postCreateCommand` to run custom installation commands, or you can choose from pre-written installation commands called "features." For more information, see the [dev containers specification](https://containers.dev/implementors/json_reference/#lifecycle-scripts) on the Development Containers website and "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/adding-features-to-a-devcontainer-file)." -- To install tools or customize your setup in every codespace you create, such as configuring your `bash` profile, you can link {% data variables.product.prodname_github_codespaces %} with a dotfiles repository. The dotfiles repository is also cloned into the persistent `/workspaces` directory. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." +- To install tools or customize your setup in every codespace you create, such as configuring your `bash` profile, you can link {% data variables.product.prodname_github_codespaces %} with a dotfiles repository. The dotfiles repository is also cloned into the persistent `/workspaces` directory. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles)." - If you want to preserve specific files over a rebuild, you can use a `devcontainer.json` file to create a symlink between the files and a persistent directory within `/workspaces`. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/rebuilding-the-container-in-a-codespace#persisting-data-over-a-rebuild)." ## Further reading diff --git a/content/codespaces/getting-started/quickstart.md b/content/codespaces/getting-started/quickstart.md index dd38160bb7cf..04bf34506266 100644 --- a/content/codespaces/getting-started/quickstart.md +++ b/content/codespaces/getting-started/quickstart.md @@ -98,7 +98,7 @@ When you connect to a codespace using the browser, or the {% data variables.prod ### About Settings Sync -You can enable Settings Sync to sync extensions and other settings across devices and instances of {% data variables.product.prodname_vscode_shortname %}. {% data reusables.codespaces.about-settings-sync %} For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#settings-sync)." +You can enable Settings Sync to sync extensions and other settings across devices and instances of {% data variables.product.prodname_vscode_shortname %}. {% data reusables.codespaces.about-settings-sync %} For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#settings-sync)." ## Next steps @@ -114,5 +114,5 @@ You've successfully created, personalized, and run your first application within - "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code)" - "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide)" - "[AUTOTITLE](/codespaces/developing-in-a-codespace/using-github-codespaces-with-github-cli)" -- "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)." +- "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces)." - "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization)" diff --git a/content/codespaces/getting-started/understanding-the-codespace-lifecycle.md b/content/codespaces/getting-started/understanding-the-codespace-lifecycle.md index ab635c0ce81c..d703cea9d52b 100644 --- a/content/codespaces/getting-started/understanding-the-codespace-lifecycle.md +++ b/content/codespaces/getting-started/understanding-the-codespace-lifecycle.md @@ -43,13 +43,13 @@ Your work will be saved on a virtual machine in the cloud. You can close and sto ## Timeouts for {% data variables.product.prodname_github_codespaces %} -If you leave your codespace running without interaction, or if you exit your codespace without explicitly stopping it, the codespace will timeout after a period of inactivity and stop running. By default, a codespace will timeout after 30 minutes of inactivity, but you can customize the duration of the timeout period for new codespaces that you create. For more information about setting the default timeout period for your codespaces, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." For more information about stopping a codespace, see "[Stopping a codespace](#stopping-a-codespace)." +If you leave your codespace running without interaction, or if you exit your codespace without explicitly stopping it, the codespace will timeout after a period of inactivity and stop running. By default, a codespace will timeout after 30 minutes of inactivity, but you can customize the duration of the timeout period for new codespaces that you create. For more information about setting the default timeout period for your codespaces, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces)." For more information about stopping a codespace, see "[Stopping a codespace](#stopping-a-codespace)." When a codespace times out, your data is preserved from the last time your changes were saved. For more information, see "[Saving changes in a codespace](#saving-changes-in-a-codespace)." ## Rebuilding a codespace -You can rebuild your codespace to implement changes to your dev container configuration. For most uses, you can create a new codespace as an alternative to rebuilding a codespace. By default, when you rebuild your codespace, {% data variables.product.prodname_github_codespaces %} will reuse images from your cache to speed up the rebuild process. Alternatively, you can perform a full rebuild, which clears your cache and rebuilds the container with fresh images. +You can rebuild your codespace to implement changes you've made to your dev container configuration. For most uses, you can create a new codespace as an alternative to rebuilding a codespace. By default, when you rebuild your codespace, {% data variables.product.prodname_github_codespaces %} will reuse images from your cache to speed up the rebuild process. Alternatively, you can perform a full rebuild, which clears your cache and rebuilds the container with fresh images. {% data reusables.codespaces.rebuild-note %} @@ -65,7 +65,7 @@ You can create a codespace for a particular task and then safely delete the code If you try to delete a codespace with unpushed git commits, your editor will notify you that you have changes that have not been pushed to a remote branch. You can push any desired changes and then delete your codespace, or continue to delete your codespace and any uncommitted changes. You can also export your code to a new branch without creating a new codespace. For more information, see "[AUTOTITLE](/codespaces/troubleshooting/exporting-changes-to-a-branch)." -Codespaces that have been stopped and remain inactive for a specified period of time will be deleted automatically. By default, inactive codespaces are deleted after 30 days, but you can customize your codespace retention period. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." +Codespaces that have been stopped and remain inactive for a specified period of time will be deleted automatically. By default, inactive codespaces are deleted after 30 days, but you can customize your codespace retention period. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces)." If you create a codespace, it will continue to accrue storage charges until it is deleted, irrespective of whether it is active or stopped. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#about-billing-for-storage-usage)." Deleting a codespace does not reduce the current billable amount for {% data variables.product.prodname_github_codespaces %}, which accumulates during each monthly billing cycle. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/viewing-your-github-codespaces-usage)." diff --git a/content/codespaces/guides.md b/content/codespaces/guides.md index a9f5dc870872..b5cabaeaadc2 100644 --- a/content/codespaces/guides.md +++ b/content/codespaces/guides.md @@ -22,7 +22,7 @@ includeGuides: - /codespaces/setting-up-your-project-for-codespaces/configuring-dev-containers/specifying-recommended-secrets-for-a-repository - /codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/facilitating-quick-creation-and-resumption-of-codespaces - /codespaces/setting-up-your-project-for-codespaces/setting-up-your-repository/setting-up-a-template-repository-for-github-codespaces - - /codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account + - /codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account - /codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository - /codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template - /codespaces/developing-in-a-codespace/developing-in-a-codespace @@ -37,17 +37,13 @@ includeGuides: - /codespaces/developing-in-a-codespace/using-source-control-in-your-codespace - /codespaces/developing-in-a-codespace/using-github-codespaces-for-pull-requests - /codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace - - /codespaces/customizing-your-codespace/changing-the-machine-type-for-your-codespace - - /codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces - - /codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account - - /codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces - - /codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces - - /codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces + - /codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces + - /codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces + - /codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces + - /codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces - /codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces - /codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces - /codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces - - /codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces - - /codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces - /codespaces/managing-codespaces-for-your-organization/enabling-or-disabling-github-codespaces-for-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization - /codespaces/managing-codespaces-for-your-organization/managing-secrets-for-your-repository-and-organization-for-github-codespaces @@ -62,4 +58,3 @@ includeGuides: - /codespaces/reference/disaster-recovery-for-github-codespaces - /codespaces/reference/security-in-github-codespaces --- - diff --git a/content/codespaces/index.md b/content/codespaces/index.md index 956b7e57302b..9efb1199ce37 100644 --- a/content/codespaces/index.md +++ b/content/codespaces/index.md @@ -17,7 +17,7 @@ featuredLinks: - /codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository - /codespaces/developing-in-a-codespace/creating-a-codespace-from-a-template - /codespaces/developing-in-a-codespace/opening-an-existing-codespace - - /codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account + - /codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account - /codespaces/developing-in-a-codespace/using-github-codespaces-in-visual-studio-code - /codespaces/developing-in-a-codespace/using-github-codespaces-in-your-jetbrains-ide popular: @@ -46,6 +46,7 @@ children: - /getting-started - /developing-in-a-codespace - /customizing-your-codespace + - /setting-your-user-preferences - /setting-up-your-project-for-codespaces - /prebuilding-your-codespaces - /managing-your-codespaces @@ -55,4 +56,3 @@ children: - /the-githubdev-web-based-editor - /guides --- - diff --git a/content/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization.md b/content/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization.md index 1368c57a545a..198513e406b6 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization.md +++ b/content/codespaces/managing-codespaces-for-your-organization/choosing-who-owns-and-pays-for-codespaces-in-your-organization.md @@ -56,7 +56,7 @@ If your organization owns a codespace, your organization has control over that c - Use the [REST API](/rest/codespaces/organizations) to manage codespaces, such as stopping or deleting a codespace - Access audit logs to review actions related to {% data variables.product.prodname_github_codespaces %} -- Set policies to manage constraints, such as restricting the base image or machine type that can be used in codespaces, or setting a default timeout and retention period +- Set policies to manage constraints, such as restricting the dev container image or machine type that can be used in codespaces, or setting a default timeout and retention period If a user owns a codespace, your organization does not have any of these options for managing the codespace, even if the codespace was created from one of your organization's repositories. diff --git a/content/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization.md b/content/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization.md index c7b75634d38b..4e556be76af2 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization.md +++ b/content/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization.md @@ -62,7 +62,7 @@ As an organization owner, you can delete any codespace in your organization. For {% note %} -**Note:** Codespaces are automatically deleted after they have been stopped and have remained inactive for a user-definable number of days. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." As an organization owner, you can set the maximum retention period for codespaces owned by your organization. This will override a user's personal retention setting. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)." +**Note:** Codespaces are automatically deleted after they have been stopped and have remained inactive for a user-definable number of days. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces)." As an organization owner, you can set the maximum retention period for codespaces owned by your organization. This will override a user's personal retention setting. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces)." {% endnote %} diff --git a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces.md b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces.md index 533519407164..df927a262c68 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces.md +++ b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces.md @@ -1,7 +1,7 @@ --- title: Restricting the base image for codespaces shortTitle: Restrict base image -intro: You can specify which base images can be used for new codespaces created within your organization. +intro: You can specify which base images can be used to create the dev container for new codespaces created within your organization. permissions: 'To manage image constraints for an organization''s codespaces, you must be an owner of the organization.' versions: fpt: '*' @@ -14,7 +14,7 @@ product: '{% data reusables.gated-features.codespaces-org %}' ## Overview -When you create a codespace, a Docker container is automatically created on a remote virtual machine. The Docker container is created from a Docker image. The image is effectively a template for Docker containers and it determines many aspects of the resulting environment provided by the codespace. +When you create a codespace, a development container is automatically created on a remote virtual machine. This dev container is created from a Docker image. The image is effectively a template for Docker containers and it determines many aspects of the resulting environment provided by the codespace. For more information, see "[AUTOTITLE](/codespaces/overview#what-is-a-codespace)." You can choose which image you want to use for your codespaces by specifying it in the dev container configuration for a repository. You can do this, for example, by using the `image` property in the `devcontainer.json` file. @@ -24,9 +24,9 @@ You can choose which image you want to use for your codespaces by specifying it For more information, see the [dev containers specification](https://containers.dev/implementors/json_reference/) on the Development Containers website. -If you don't specify an image in the dev container configuration for a repository, the default image is used. The default image contains a number of runtime versions for popular languages and commonly used tools. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration)." +If you don't specify an image in the dev container configuration for a repository, the default dev container image is used. The default image contains a number of runtime versions for popular languages and commonly used tools. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration)." -As an organization owner, you can add a policy to restrict which images can be used for codespaces created within your organization. +As an organization owner, you can add a policy to restrict which dev container images can be used for codespaces created within your organization. If the image specified in the dev container configuration does not match one of the allowed images, the following message is displayed when someone tries to create a codespace for the repository: @@ -35,6 +35,7 @@ If the image specified in the dev container configuration does not match one of {% note %} **Notes**: +- The dev container base image should not be confused with the host image. The host image is the image used to build the virtual machine on which the dev container runs. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/choosing-the-stable-or-beta-host-image)." - The base image policy is only applied when a codespace is created. It is currently not applied when you rebuild a container. This will change in a future release. For more information, see "[AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle#rebuilding-a-codespace)." - The base image policy does not apply to the default image, or the image that's used to recover a codespace if an error is introduced into a dev container configuration which prevents the container from being rebuilt. diff --git a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md index ac0487ffb047..3c70c3680d97 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md +++ b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-idle-timeout-period.md @@ -16,7 +16,7 @@ product: '{% data reusables.gated-features.codespaces-org %}' By default, codespaces time out after 30 minutes of inactivity. When a codespace times out it is stopped and will no longer incur charges for compute usage. -The personal settings of a {% data variables.product.prodname_dotcom %} user allow them to define their own timeout period for codespaces they create. This may be longer than the default 30-minute period. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." +The personal settings of a {% data variables.product.prodname_dotcom %} user allow them to define their own timeout period for codespaces they create. This may be longer than the default 30-minute period. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces)." As an organization owner, you may want to configure constraints on the maximum idle timeout period for codespaces created for repositories owned by your organization. This can help you to limit costs associated with codespaces that are left to timeout after long periods of inactivity. You can set a maximum timeout for the codespaces for all repositories owned by your organization, or for the codespaces of specific repositories. diff --git a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md index bab1501d2ea3..35c74033f1d7 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md +++ b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-retention-period-for-codespaces.md @@ -16,13 +16,13 @@ product: '{% data reusables.gated-features.codespaces-org %}' {% data reusables.codespaces.automatic-deletion %} -{% data variables.product.prodname_dotcom %} users can set a personal retention period of less than 30 days for codespaces they create. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." +{% data variables.product.prodname_dotcom %} users can set a personal retention period of less than 30 days for codespaces they create. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces)." As an organization owner, you may want to configure constraints on the maximum retention period for codespaces created for the repositories owned by your organization. This can help you to limit the storage costs associated with codespaces that are stopped and then left unused until they are automatically deleted. For more information about storage charges, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#codespaces-pricing)." You can set a maximum retention period for all, or for specific, repositories owned by your organization. {% note %} -**Note**: Setting a maximum retention policy for a repository prevents people from exempting a codespace from automatic deletion. The "Keep codespace" option will be unavailable for codespaces created for that repository. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces?tool=webui#avoiding-automatic-deletion-of-codespaces)." +**Note**: Setting a maximum retention policy for a repository prevents people from exempting a codespace from automatic deletion. The "Keep codespace" option will be unavailable for codespaces created for that repository. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces?tool=webui#avoiding-automatic-deletion-of-codespaces)." {% endnote %} diff --git a/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md b/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md index c4b72be2d3b8..348c20eec0c8 100644 --- a/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md +++ b/content/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces.md @@ -24,7 +24,7 @@ By default, GPG verification is disabled for codespaces you create. If you enabl {% data reusables.codespaces.settings-sync-and-gpg %} -For more information about managing your preferences for Settings Sync, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#managing-your-preferences-for-settings-sync)." +For more information about managing your preferences for Settings Sync, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#managing-your-preferences-for-settings-sync)." {% note %} @@ -40,3 +40,8 @@ For more information about managing your preferences for Settings Sync, see "[AU {% data reusables.codespaces.trusted-repos-step %} {% data reusables.codespaces.gpg-in-active-codespaces %} + +## Further reading + +- "[AUTOTITLE](/codespaces/setting-your-user-preferences)" +- "[AUTOTITLE](/codespaces/customizing-your-codespace)" diff --git a/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md b/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md index 042a7db1e8ec..ded472f80328 100644 --- a/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md +++ b/content/codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces.md @@ -143,3 +143,8 @@ When you enable access and security for a repository owned by your personal acco - **Selected repositories** - Personal codespaces created from specific repositories can access other repositories you own. 1. If you chose "Selected repositories", select the "Select repositories" dropdown menu, then click a repository to allow the repository's codespaces to access other repositories you own. Repeat this step for all repositories whose codespaces you want to access other repositories you own. + +## Further reading + +- "[AUTOTITLE](/codespaces/setting-your-user-preferences)" +- "[AUTOTITLE](/codespaces/customizing-your-codespace)" diff --git a/content/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces.md b/content/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces.md index da583b39a329..9debc6fe5e01 100644 --- a/content/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces.md +++ b/content/codespaces/managing-your-codespaces/managing-secrets-for-your-codespaces.md @@ -98,3 +98,5 @@ Development environment secrets cannot be used: - "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/managing-secrets-for-your-repository-and-organization-for-github-codespaces)" - "[AUTOTITLE](/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository#recommended-secrets)" +- "[AUTOTITLE](/codespaces/setting-your-user-preferences)" +- "[AUTOTITLE](/codespaces/customizing-your-codespace)" diff --git a/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-github-codespaces.md b/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-github-codespaces.md index c189a2e86559..1ed838e8f0c2 100644 --- a/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-github-codespaces.md +++ b/content/codespaces/managing-your-codespaces/reviewing-your-security-logs-for-github-codespaces.md @@ -25,3 +25,5 @@ The security log includes details on what action occurred and when you performed - "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/reviewing-your-organizations-audit-logs-for-github-codespaces)" - "[AUTOTITLE](/codespaces/troubleshooting/github-codespaces-logs)" +- "[AUTOTITLE](/codespaces/setting-your-user-preferences)" +- "[AUTOTITLE](/codespaces/customizing-your-codespace)" diff --git a/content/codespaces/overview.md b/content/codespaces/overview.md index c727e0da07a9..d21dba253ef3 100644 --- a/content/codespaces/overview.md +++ b/content/codespaces/overview.md @@ -23,9 +23,9 @@ A codespace is a development environment that's hosted in the cloud. You can cus Each codespace you create is hosted by {% data variables.product.prodname_dotcom %} in a Docker container, running on a virtual machine. You can choose from a selection of virtual machine types, from 2 cores, 8 GB RAM, and 32 GB storage, up to 32 cores, 64 GB RAM, and 128 GB storage. -By default, codespaces are created from an Ubuntu Linux image that includes a selection of popular languages and tools, but you can use an image based on a Linux distribution of your choice and configure it for your particular requirements. Regardless of your local operating system, your codespace will run in a Linux environment. Windows and MacOS are not supported operating systems for the remote container. +By default, the codespace development environment is created from an Ubuntu Linux image that includes a selection of popular languages and tools, but you can use an image based on a Linux distribution of your choice and configure it for your particular requirements. Regardless of your local operating system, your codespace will run in a Linux environment. Windows and MacOS are not supported operating systems for the remote development container. -You can connect to your codespaces from your browser, from {% data variables.product.prodname_vscode %}, from the JetBrains Gateway application, or by using {% data variables.product.prodname_cli %}. When you connect, you are placed within the Docker container. You do not have access to the outer Linux virtual machine host. +You can connect to your codespaces from your browser, from {% data variables.product.prodname_vscode %}, from the JetBrains Gateway application, or by using {% data variables.product.prodname_cli %}. When you connect, you are placed within the Docker container. You have limited access to the outer Linux virtual machine host. ![Diagram showing the relationship between a code editor and a codespace running on an Azure virtual machine.](/assets/images/help/codespaces/codespaces-diagram.png) @@ -72,7 +72,7 @@ If use of a codespace will be billed to an organization or enterprise, this is s To customize the runtimes and tools in your codespace, you can create one or more dev container configurations for your repository. Adding dev container configurations to your repository allows you to define a choice of different development environments that are appropriate for the work people will do in your repository. -If you create a codespace from a repository without any dev container configurations, {% data variables.product.prodname_github_codespaces %} will clone your repository into an environment with the default codespace image that includes many tools, languages, and runtime environments. If you create a codespace from a template, you might start with some initial configuration on top of the default image. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." +If you create a codespace from a repository without any dev container configurations, {% data variables.product.prodname_github_codespaces %} will clone your repository into an environment with the default dev container image that includes many tools, languages, and runtime environments. If you create a codespace from a template, you might start with some initial configuration on top of the default image. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." You can personalize aspects of your codespace environment by using a public [dotfiles](https://dotfiles.github.io/tutorials/) repository. You can use dotfiles to set shell aliases and preferences, or to install your personal preference of the tools you like to use. If you use {% data variables.product.prodname_github_codespaces %} in the browser, or in {% data variables.product.prodname_vscode %}, you can use [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to give your codespace editor the same settings, keyboard shortcuts, snippets, and extensions that you have set up in your local installation of {% data variables.product.prodname_vscode %}. diff --git a/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md b/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md index 0865d3bbde8c..040859c1f71f 100644 --- a/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md +++ b/content/codespaces/prebuilding-your-codespaces/configuring-prebuilds.md @@ -85,7 +85,7 @@ For repositories owned by an organization, you can set up prebuilds if the organ **Notes**: - The prebuild in each region incurs individual storage charges. You should, therefore, only enable prebuilds for regions in which you know they'll be used. For more information, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#about-billing-for-codespaces-prebuilds)." - - Developers can set their default region for {% data variables.product.prodname_github_codespaces %}, which can allow you to enable prebuilds for fewer regions. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)." + - Developers can set their default region for {% data variables.product.prodname_github_codespaces %}, which can allow you to enable prebuilds for fewer regions. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces)." {% endnote %} diff --git a/content/codespaces/reference/disaster-recovery-for-github-codespaces.md b/content/codespaces/reference/disaster-recovery-for-github-codespaces.md index 8836ba21484d..e249a9da8408 100644 --- a/content/codespaces/reference/disaster-recovery-for-github-codespaces.md +++ b/content/codespaces/reference/disaster-recovery-for-github-codespaces.md @@ -26,7 +26,7 @@ The following guidance provides options on how to handle service disruption to t ## Option 1: Create a new codespace in another region -In the case of a regional outage, we suggest you recreate your codespace in an unaffected region to continue working. This new codespace will have all of the changes as of your last push to {% data variables.product.prodname_dotcom %}. For information on manually setting another region, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)." +In the case of a regional outage, we suggest you recreate your codespace in an unaffected region to continue working. This new codespace will have all of the changes as of your last push to {% data variables.product.prodname_dotcom %}. For information on manually setting another region, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces)." You can optimize recovery time by configuring a `devcontainer.json` in the project's repository, which allows you to define the tools, runtimes, frameworks, editor settings, extensions, and other configuration necessary to restore the development environment automatically. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers)." diff --git a/content/codespaces/reference/security-in-github-codespaces.md b/content/codespaces/reference/security-in-github-codespaces.md index c6635c667a9c..8a5ee44123a2 100644 --- a/content/codespaces/reference/security-in-github-codespaces.md +++ b/content/codespaces/reference/security-in-github-codespaces.md @@ -127,4 +127,4 @@ Any additional {% data variables.product.prodname_vscode_shortname %} extensions {% data variables.product.prodname_vscode_shortname %}'s Settings Sync can allow potentially malicious content to transfer across devices. By default, Settings Sync is disabled for codespaces opened in the browser. If you're creating a codespace for a repository whose contents you do not trust, you should open the codespace in the browser and leave Settings Sync turned off. -If you have enabled Settings Sync in your user preferences, and want to allow changes to your settings to sync from your codespaces to other instances of {% data variables.product.prodname_vscode_shortname %}, we recommend you add a selected list of trusted repositories, rather than trusting all repositories. When you create codespaces from trusted repositories, changes you make to your settings in the codespaces are synced to your cached settings in the cloud, from which they can transfer to your devices. For more information about managing Settings Sync, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#settings-sync)." +If you have enabled Settings Sync in your user preferences, and want to allow changes to your settings to sync from your codespaces to other instances of {% data variables.product.prodname_vscode_shortname %}, we recommend you add a selected list of trusted repositories, rather than trusting all repositories. When you create codespaces from trusted repositories, changes you make to your settings in the codespaces are synced to your cached settings in the cloud, from which they can transfer to your devices. For more information about managing Settings Sync, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#settings-sync)." diff --git a/content/codespaces/reference/using-github-copilot-in-github-codespaces.md b/content/codespaces/reference/using-github-copilot-in-github-codespaces.md index 806562901ffe..eaded57b3881 100644 --- a/content/codespaces/reference/using-github-copilot-in-github-codespaces.md +++ b/content/codespaces/reference/using-github-copilot-in-github-codespaces.md @@ -20,7 +20,7 @@ redirect_from: To start using {% data variables.product.prodname_copilot %} in {% data variables.product.prodname_github_codespaces %}, install the [{% data variables.product.prodname_copilot %} extension from the {% data variables.product.prodname_vscode_marketplace %}](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot). -To include {% data variables.product.prodname_copilot %}, or other extensions, in all of your codespaces, enable Settings Sync. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#settings-sync)." Additionally, to include {% data variables.product.prodname_copilot %} in a given project for all users, you can specify `GitHub.copilot` as an extension in your `devcontainer.json` file. For information about configuring a `devcontainer.json` file, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#creating-a-custom-dev-container-configuration)." +To include {% data variables.product.prodname_copilot %}, or other extensions, in all of your codespaces, enable Settings Sync. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#settings-sync)." Additionally, to include {% data variables.product.prodname_copilot %} in a given project for all users, you can specify `GitHub.copilot` as an extension in your `devcontainer.json` file. For information about configuring a `devcontainer.json` file, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#creating-a-custom-dev-container-configuration)." ## Further reading diff --git a/content/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers.md b/content/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers.md index 319906f4a922..57f95c47e2b6 100644 --- a/content/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers.md +++ b/content/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers.md @@ -55,7 +55,7 @@ For information about how to choose your preferred dev container configuration w It's useful to think of the `devcontainer.json` file as providing "customization" rather than "personalization." You should only include things that everyone working on your codebase needs as standard elements of the development environment, not things that are personal preferences. Things like linters are good to standardize on, and to require everyone to have installed, so they're good to include in your `devcontainer.json` file. Things like user interface decorators or themes are personal choices that should not be put in the `devcontainer.json` file. -You can personalize your codespaces by using dotfiles and Settings Sync. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account)." +You can personalize your codespaces by using dotfiles and Settings Sync. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account)." ### Dockerfile @@ -116,7 +116,7 @@ Various options are available to you if you want to use existing container orche ## Using the default dev container configuration -If you don't add a dev container configuration to your repository, or if your configuration does not specify an image to use, then {% data variables.product.prodname_dotcom %} creates a container from a default Linux image. This Linux image includes a number of runtime versions for popular languages like Python, Node, PHP, Java, Go, C++, Ruby, and .NET Core/C#. The latest or LTS releases of these languages are used. There are also tools to support data science and machine learning, such as JupyterLab and Conda. The image also includes other developer tools and utilities like Git, GitHub CLI, yarn, openssh, and vim. To see all the languages, runtimes, and tools that are included use the `devcontainer-info content-url` command inside your codespace terminal and follow the URL that the command outputs. +If you don't add a dev container configuration to your repository, or if your configuration does not specify a base image to use, then {% data variables.product.prodname_dotcom %} creates a container from a default Linux image. This Linux image includes a number of runtime versions for popular languages like Python, Node, PHP, Java, Go, C++, Ruby, and .NET Core/C#. The latest or LTS releases of these languages are used. There are also tools to support data science and machine learning, such as JupyterLab and Conda. The default dev container image also includes other developer tools and utilities like Git, GitHub CLI, yarn, openssh, and vim. To see all the languages, runtimes, and tools that are included use the `devcontainer-info content-url` command inside your codespace terminal and follow the URL that the command outputs. {% data reusables.codespaces.default-image-contents %} @@ -124,7 +124,7 @@ The default configuration is a good option if you're working on a small project {% note %} -**Note**: {% data variables.product.prodname_dotcom %} does not charge for storage of containers built from the default Linux image. For more information about billing for codespace storage, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#about-billing-for-storage-usage)." {% data reusables.codespaces.check-for-default-image %} +**Note**: {% data variables.product.prodname_dotcom %} does not charge for storage of containers built from the default dev container image. For more information about billing for codespace storage, see "[AUTOTITLE](/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces#about-billing-for-storage-usage)." {% data reusables.codespaces.check-for-default-image %} {% endnote %} diff --git a/content/codespaces/setting-your-user-preferences/choosing-the-stable-or-beta-host-image.md b/content/codespaces/setting-your-user-preferences/choosing-the-stable-or-beta-host-image.md new file mode 100644 index 000000000000..fb4e9b6b351b --- /dev/null +++ b/content/codespaces/setting-your-user-preferences/choosing-the-stable-or-beta-host-image.md @@ -0,0 +1,46 @@ +--- +title: Choosing the stable or beta host image +shortTitle: Choose the host image +intro: 'You can choose to build codespaces using either the stable or beta version of the host image for the underlying virtual machine.' +versions: + fpt: '*' + ghec: '*' +type: how_to +topics: + - Codespaces + - Set up +--- + +## About the virtual machine host image + +A {% data variables.product.prodname_dotcom %} codespace is a development environment provided by a Docker container that runs on a virtual machine (VM). For more information about the relationship of the development container and the VM, see "[AUTOTITLE](/codespaces/overview#what-is-a-codespace)." + +The VM for a codespace is built using a host image that defines the operating system of the VM. The image is periodically upgraded to improve security, functionality, and performance. The upgraded host image is initially made available as a beta release and subsequently becomes the stable release after a period of testing. You can choose, in your personal settings, to use either the stable or beta version of the host image. Any codespace you create or resume after changing this setting will run on a VM built from the specified host image. + +The stable image is the default selected setting. Changing the setting to the beta host image gives you early access to improvements and new features on the host VM, but may also introduce incompatibilities with your current dev container configuration. This gives you the opportunity to alter your dev container configuration to avoid problems before the beta image is promoted to the stable image. If you do encounter problems with the beta host image, you can switch back to the stable host image at any time. + +{% note %} + +**Notes**: + +- It's unlikely you will encounter problems using the beta host image unless your dev container configuration has dependencies on components of the VM host kernel. +- The virtual machine host image should not be confused with the dev container image, which provides the environment of your codespace. For more information, see "[AUTOTITLE](/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces#overview)." + +{% endnote %} + +If you choose to use the beta host image but no beta image is currently available, your codespaces will be built using the stable host image. + +For information about the current host image versions, including the date on which the current stable image will be replaced by the current beta image, see [the `github/codespaces-host-images` repository](https://github.com/github/codespaces-host-images/blob/main/README.md). + +## Choosing the host image + +{% data reusables.user-settings.access_settings %} +{% data reusables.user-settings.codespaces-tab %} +1. Under "Host image version preference", select either **Stable** or **Beta**. + + ![Screenshot of the "Host image version preference" options, with "Stable" selected.](/assets/images/help/codespaces/host-image-choice.png) + +## Further reading + +- "[AUTOTITLE](/codespaces/customizing-your-codespace)" +- "[AUTOTITLE](/codespaces/managing-your-codespaces)" diff --git a/content/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces.md b/content/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces.md similarity index 96% rename from content/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces.md rename to content/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces.md index bcca4e702bcd..3754cb817218 100644 --- a/content/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces.md +++ b/content/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces.md @@ -2,6 +2,8 @@ title: Configuring automatic deletion of your codespaces shortTitle: Configure automatic deletion intro: 'Inactive codespaces are automatically deleted. You can choose how long your stopped codespaces are retained, up to a maximum of 30 days.' +redirect_from: + - /codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces versions: fpt: '*' ghec: '*' @@ -49,7 +51,7 @@ Each codespace has its own retention period. You may, therefore, have codespaces {% warning %} - **Warning**: Setting the period to `0` will result in your codespaces being immediately deleted when you stop them, or when they timeout due to inactivity. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." + **Warning**: Setting the period to `0` will result in your codespaces being immediately deleted when you stop them, or when they timeout due to inactivity. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces)." {% endwarning %} @@ -127,3 +129,8 @@ You can check, in the {% data variables.product.prodname_vscode %} desktop appli ![Screenshot of the "Remote Explorer" side bar. In the right-click menu for a codespace, "Expiring in 19 days" is highlighted with an orange outline.](/assets/images/help/codespaces/vscode-deleting-in-5-days.png) {% endvscode %} + +## Further reading + +- "[AUTOTITLE](/codespaces/customizing-your-codespace)" +- "[AUTOTITLE](/codespaces/managing-your-codespaces)" diff --git a/content/codespaces/setting-your-user-preferences/index.md b/content/codespaces/setting-your-user-preferences/index.md new file mode 100644 index 000000000000..9ce11c1e3efe --- /dev/null +++ b/content/codespaces/setting-your-user-preferences/index.md @@ -0,0 +1,16 @@ +--- +title: Setting your user preferences +intro: 'You can adjust your personal settings for {% data variables.product.prodname_github_codespaces %} so that the codespaces you create always give you the development experience that works best for you.' +versions: + fpt: '*' + ghec: '*' +topics: + - Codespaces +children: + - /personalizing-github-codespaces-for-your-account + - /setting-your-default-editor-for-github-codespaces + - /setting-your-default-region-for-github-codespaces + - /setting-your-timeout-period-for-github-codespaces + - /configuring-automatic-deletion-of-your-codespaces + - /choosing-the-stable-or-beta-host-image +--- diff --git a/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md b/content/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account.md similarity index 95% rename from content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md rename to content/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account.md index f1f6c486c064..07b97e81806a 100644 --- a/content/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account.md +++ b/content/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account.md @@ -7,6 +7,7 @@ redirect_from: - /github/developing-online-with-codespaces/personalizing-codespaces-for-your-account - /codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account - /codespaces/customizing-your-codespace/personalizing-codespaces-for-your-account + - /codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account versions: fpt: '*' ghec: '*' @@ -164,13 +165,14 @@ If your codespace fails to pick up configuration settings from dotfiles, see "[A You can also personalize {% data variables.product.prodname_github_codespaces %} using additional options in [your personal settings](https://github.com/settings/codespaces): - To enable GPG verification, see "[AUTOTITLE](/codespaces/managing-your-codespaces/managing-gpg-verification-for-github-codespaces)." -- To set your editor, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)." -- To set how long a codespace can remain unused before it is automatically stopped, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." -- To set the period for which your unused codespaces are retained, see "[AUTOTITLE](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." -- To set your default region, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces)." +- To set your editor, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces)." +- To set how long a codespace can remain unused before it is automatically stopped, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces)." +- To set the period for which your unused codespaces are retained, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces)." +- To set your default region, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces)." ## Further reading - "[AUTOTITLE](/repositories/creating-and-managing-repositories/creating-a-new-repository)" - "[AUTOTITLE](/codespaces/getting-started/deep-dive#personalizing-your-codespace-with-extensions-or-plugins)" -- "[AUTOTITLE](/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace)" +- "[AUTOTITLE](/codespaces/customizing-your-codespace)" +- "[AUTOTITLE](/codespaces/managing-your-codespaces)" diff --git a/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces.md b/content/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md similarity index 94% rename from content/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces.md rename to content/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md index 3436bf88e6ca..87d14a6815f6 100644 --- a/content/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces.md +++ b/content/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces.md @@ -8,6 +8,7 @@ versions: redirect_from: - /codespaces/managing-your-codespaces/setting-your-default-editor-for-codespaces - /codespaces/customizing-your-codespace/setting-your-default-editor-for-codespaces + - /codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces topics: - Codespaces type: how_to @@ -50,3 +51,8 @@ If you want to work on a codespace in a JetBrains IDE you must install the JetBr To connect to a codespace from the Gateway application, you must have an SSH server running on the codespace. {% indented_data_reference reusables.codespaces.ssh-server-installed spaces=5 %} - If you choose **JupyterLab**, the JupyterLab application must be installed in the codespaces you open. {% data reusables.codespaces.jupyterlab-in-default-image %} + +## Further reading + +- "[AUTOTITLE](/codespaces/customizing-your-codespace)" +- "[AUTOTITLE](/codespaces/managing-your-codespaces)" diff --git a/content/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces.md b/content/codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces.md similarity index 82% rename from content/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces.md rename to content/codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces.md index aa4c4317da08..0cd6311e08d9 100644 --- a/content/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces.md +++ b/content/codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces.md @@ -8,6 +8,7 @@ versions: redirect_from: - /codespaces/managing-your-codespaces/setting-your-default-region-for-codespaces - /codespaces/customizing-your-codespace/setting-your-default-region-for-codespaces + - /codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces topics: - Codespaces type: how_to @@ -22,3 +23,8 @@ You can manually select the region that your codespaces will be created in, allo 1. Under "Region", select the setting you want: **Set automatically** or **Set manually**. 1. If you chose **Set manually**, select the dropdown menu and click your region. + +## Further reading + +- "[AUTOTITLE](/codespaces/customizing-your-codespace)" +- "[AUTOTITLE](/codespaces/managing-your-codespaces)" diff --git a/content/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces.md b/content/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces.md similarity index 94% rename from content/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces.md rename to content/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces.md index c84bea2b387c..54d23dbe4326 100644 --- a/content/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces.md +++ b/content/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces.md @@ -2,14 +2,15 @@ title: Setting your timeout period for GitHub Codespaces shortTitle: Set the timeout intro: 'You can set your default timeout for {% data variables.product.prodname_github_codespaces %} in your personal settings page.' +redirect_from: + - /codespaces/customizing-your-codespace/setting-your-timeout-period-for-codespaces + - /codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces versions: fpt: '*' ghec: '*' topics: - Codespaces type: how_to -redirect_from: - - /codespaces/customizing-your-codespace/setting-your-timeout-period-for-codespaces --- ## About the idle timeout @@ -65,3 +66,8 @@ If you don't specify a timeout period when you create a codespace, then the defa You can set your default timeout period in your web browser, on {% data variables.product.prodname_dotcom_the_website %}. Alternatively, if you use {% data variables.product.prodname_cli %} to create a codespace you can set a timeout period for that particular codespace. For more information, click the appropriate tab above. {% endvscode %} + +## Further reading + +- "[AUTOTITLE](/codespaces/customizing-your-codespace)" +- "[AUTOTITLE](/codespaces/managing-your-codespaces)" diff --git a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md index 9e5ad572ef87..8cf1811c3c1e 100644 --- a/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-creation-and-deletion-of-codespaces.md @@ -80,7 +80,7 @@ A codespace can only be deleted by: - An organization owner for an organization-owned codespace. - Automatic deletion at the end of a retention period. -For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/deleting-a-codespace)" and "[AUTOTITLE](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." +For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/deleting-a-codespace)" and "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces)." ## Container storage diff --git a/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md index af81e4d479f0..2f27c51916c4 100644 --- a/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-gpg-verification-for-github-codespaces.md @@ -40,7 +40,7 @@ To check that the value has been correctly removed from your configuration, you To automatically sign your commits, {% data variables.product.prodname_github_codespaces %} sets certain Git configuration values in your codespace. If you override the values set by {% data variables.product.prodname_github_codespaces %}, you may be unable to sign your commits. -You may be inadvertently overriding these values if you have linked {% data variables.product.prodname_github_codespaces %} with a dotfiles repository that contains Git configuration files. For more information about using dotfiles with {% data variables.product.prodname_github_codespaces %}, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." +You may be inadvertently overriding these values if you have linked {% data variables.product.prodname_github_codespaces %} with a dotfiles repository that contains Git configuration files. For more information about using dotfiles with {% data variables.product.prodname_github_codespaces %}, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles)." ### Checking for conflicting configuration @@ -118,7 +118,7 @@ If GPG verification is disabled in your settings for {% data variables.product.p If you find this setting is enabled, you should either deselect the checkbox to stop {% data variables.product.prodname_vscode_shortname %} trying to sign your commits, or you should enable GPG verification for the repository you're working in so your commits can be signed successfully. -If you change your {% data variables.product.prodname_vscode_shortname %} settings, you must ensure Settings Sync is enabled if you want to share your changes with other codespaces you create. You should only turn on Settings Sync in a codespace created from a repository you trust. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#settings-sync)." +If you change your {% data variables.product.prodname_vscode_shortname %} settings, you must ensure Settings Sync is enabled if you want to share your changes with other codespaces you create. You should only turn on Settings Sync in a codespace created from a repository you trust. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#settings-sync)." ## Further reading diff --git a/content/codespaces/troubleshooting/troubleshooting-included-usage.md b/content/codespaces/troubleshooting/troubleshooting-included-usage.md index 119fa6285406..1f6c6558168f 100644 --- a/content/codespaces/troubleshooting/troubleshooting-included-usage.md +++ b/content/codespaces/troubleshooting/troubleshooting-included-usage.md @@ -65,7 +65,7 @@ To see your {% data variables.product.prodname_codespaces %} usage, filter the r ### Storage usage for your base dev container -If you don't add a dev container configuration to your repository, or if your configuration does not specify an image to use, then {% data variables.product.prodname_dotcom %} creates a container from a default Linux image. Storage of base dev containers built from the default Linux image is free of charge and does not consume your included storage. Your storage usage will be based only on the files in your repository, and any files you subsequently add to the codespace, including {% data variables.product.prodname_vscode_shortname %} extensions. If you use an alternative base image, then the resulting container and all of the files in the codespace will be counted as used storage. {% data reusables.codespaces.default-image-contents %} +If you don't add a dev container configuration to your repository, or if your configuration does not specify a dev container image to use, then {% data variables.product.prodname_dotcom %} creates a container from a default Linux image. Storage of base dev containers built from the default dev container image is free of charge and does not consume your included storage. Your storage usage will be based only on the files in your repository, and any files you subsequently add to the codespace, including {% data variables.product.prodname_vscode_shortname %} extensions. If you use an alternative base image, then the resulting container and all of the files in the codespace will be counted as used storage. {% data reusables.codespaces.default-image-contents %} You can check which image was used to create a codespace's dev container. In the Terminal of your codespace, run this command. @@ -83,14 +83,14 @@ If the dev container for the current codespace was built from the default image, ## Tips for making your allowed usage go further - Your codespaces consume compute usage while they are running. If you're not using a codespace, stopping the codespace prevents unnecessary compute usage. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/stopping-and-starting-a-codespace)." -- You can reduce the idle timeout for {% data variables.product.prodname_codespaces %} in your personal settings to less than the default 30 minutes. This will shorten the period of inactivity before your codespaces are automatically stopped. This can save on compute usage. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-timeout-period-for-github-codespaces)." +- You can reduce the idle timeout for {% data variables.product.prodname_codespaces %} in your personal settings to less than the default 30 minutes. This will shorten the period of inactivity before your codespaces are automatically stopped. This can save on compute usage. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-timeout-period-for-github-codespaces)." - Your codespaces consume storage while they exist. You should delete a codespace you have finished using and know that you will not use again. For more information, see "[AUTOTITLE](/codespaces/developing-in-a-codespace/deleting-a-codespace)." {% note %} **Note**: Deleting a codespace will not reduce your used storage amount for the billing current month as this is a cumulative figure. {% endnote %} -- Configure your retention period to ensure codespaces you forget to delete are deleted automatically. The default retention period is 30 days. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." +- Configure your retention period to ensure codespaces you forget to delete are deleted automatically. The default retention period is 30 days. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces)." - {% data variables.product.prodname_vscode %} extensions consume storage. Make sure you are only installing extensions that you need. You can find out how much space is being used by extensions by running this command in your codespace. ```shell copy @@ -114,4 +114,4 @@ If the dev container for the current codespace was built from the default image, You can check for prebuild configurations in the "{% data variables.product.prodname_codespaces %}" page of a repository's settings. For more information, see "[AUTOTITLE](/codespaces/prebuilding-your-codespaces/configuring-prebuilds#configuring-prebuilds)." Alternatively, you can check which repositories have prebuilds by reviewing a usage report. For more information, see "[Understanding your {% data variables.product.prodname_codespaces %} usage](#understanding-your-codespaces-usage)" above. -- Storage of containers built from the default Linux image for codespaces is free of charge and does not reduce your included storage. You can therefore avoid your storage allowance being consumed by your dev container by using the default image in your dev container configuration, rather than specifying a more specialized image. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration)" and "[Storage usage for your base dev container](#storage-usage-for-your-base-dev-container)" above. +- Storage of containers built from the default dev container image for codespaces is free of charge and does not reduce your included storage. You can therefore avoid your storage allowance being consumed by your dev container by using the default image in your dev container configuration, rather than specifying a more specialized image. For more information, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration)" and "[Storage usage for your base dev container](#storage-usage-for-your-base-dev-container)" above. diff --git a/content/codespaces/troubleshooting/troubleshooting-personalization-for-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-personalization-for-codespaces.md index 5e95cc6eb1ca..ad1ceab2e86d 100644 --- a/content/codespaces/troubleshooting/troubleshooting-personalization-for-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-personalization-for-codespaces.md @@ -13,7 +13,7 @@ redirect_from: - /codespaces/troubleshooting/troubleshooting-dotfiles-for-codespaces --- -You can personalize {% data variables.product.prodname_github_codespaces %} by using a `dotfiles` repository on {% data variables.product.product_name %} or by using Settings Sync. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account)." +You can personalize {% data variables.product.prodname_github_codespaces %} by using a `dotfiles` repository on {% data variables.product.product_name %} or by using Settings Sync. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account)." ## Troubleshooting dotfiles diff --git a/content/codespaces/troubleshooting/troubleshooting-prebuilds.md b/content/codespaces/troubleshooting/troubleshooting-prebuilds.md index eb8e5ee8b468..c656a4c86137 100644 --- a/content/codespaces/troubleshooting/troubleshooting-prebuilds.md +++ b/content/codespaces/troubleshooting/troubleshooting-prebuilds.md @@ -22,7 +22,7 @@ If you have your {% data variables.product.prodname_github_codespaces %} editor ![Screenshot of the "Setting up your codespace" page, with the text: "Prebuilt codespace found. Downloading image."](/assets/images/help/codespaces/prebuilt-codespace-found.png) -Similarly, if your editor preference is "{% data variables.product.prodname_vscode_shortname %}" then the integrated terminal will contain the message "You are on a prebuilt codespace defined by the prebuild configuration for your repository" when you create a new codespace. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/setting-your-default-editor-for-github-codespaces)." +Similarly, if your editor preference is "{% data variables.product.prodname_vscode_shortname %}" then the integrated terminal will contain the message "You are on a prebuilt codespace defined by the prebuild configuration for your repository" when you create a new codespace. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/setting-your-default-editor-for-github-codespaces)." After you have created a codespace you can check whether it was created from a prebuild by running the following {% data variables.product.prodname_cli %} command in the terminal: diff --git a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md index 444dbcfb2fea..016eaaa27ced 100644 --- a/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md +++ b/content/codespaces/troubleshooting/troubleshooting-your-connection-to-github-codespaces.md @@ -32,7 +32,7 @@ If you still cannot connect, {% data reusables.codespaces.contact-support %} ## Unable to connect to your codespace in JupyterLab -To be able to use a codespace in JupyterLab, you must ensure that your codespace has it installed. The default container image that's used by {% data variables.product.prodname_github_codespaces %} includes JupyterLab, but if you have customized your dev container configuration you will have to manually install JupyterLab. +To be able to use a codespace in JupyterLab, you must ensure that your codespace has it installed. The default dev container image that's used by {% data variables.product.prodname_github_codespaces %} includes JupyterLab, but if you have customized your dev container configuration you will have to manually install JupyterLab. If your codespace uses a Debian-based image, you can install JupyterLab in the dev container by adding the `python` feature to your `devcontainer.json` file, with the `installJupyterlab` option set to `true`. Otherwise, install it directly in your Dockerfile. For installation instructions, see "[Installation](https://jupyterlab.readthedocs.io/en/stable/getting_started/installation.html)" in the JupyterLab documentation. @@ -55,4 +55,4 @@ If you still cannot connect, {% data reusables.codespaces.contact-support %} ### The codespace has latency issues -If the codespace seems particularly slow or has latency issues, it is possible that it has been created in a region that is far from you. To resolve this, you can [manually set your {% data variables.product.prodname_github_codespaces %} region](/codespaces/customizing-your-codespace/setting-your-default-region-for-github-codespaces). +If the codespace seems particularly slow or has latency issues, it is possible that it has been created in a region that is far from you. To resolve this, you can [manually set your {% data variables.product.prodname_github_codespaces %} region](/codespaces/setting-your-user-preferences/setting-your-default-region-for-github-codespaces). diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md index d8fab2e42b95..3adcee399857 100644 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md @@ -21,7 +21,7 @@ For assignments with complex setup environments, teachers can customize the dev {% note %} -**Note**: Individual codespaces are automatically deleted if they are stopped and left unused for a prolonged period. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)." +**Note**: Individual codespaces are automatically deleted if they are stopped and left unused for a prolonged period. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/configuring-automatic-deletion-of-your-codespaces)." {% endnote %} diff --git a/data/features/dependabot-updates-enhanced-nuget-support.yml b/data/features/dependabot-updates-enhanced-nuget-support.yml new file mode 100644 index 000000000000..a7865e39987b --- /dev/null +++ b/data/features/dependabot-updates-enhanced-nuget-support.yml @@ -0,0 +1,5 @@ +# Reference: #12731 - Improvements to NuGet Support for Dependabot Updates - [GA] +versions: + fpt: '*' + ghec: '*' + ghes: '>3.11' diff --git a/data/reusables/codespaces/check-for-default-image.md b/data/reusables/codespaces/check-for-default-image.md index d802af368c68..9a1628f6cf24 100644 --- a/data/reusables/codespaces/check-for-default-image.md +++ b/data/reusables/codespaces/check-for-default-image.md @@ -1 +1 @@ -For information on how to check whether a codespace was built from the default image, see "[AUTOTITLE](/codespaces/troubleshooting/troubleshooting-included-usage#storage-usage-for-your-base-dev-container)." +For information on how to check whether a codespace was built from the default dev container image, see "[AUTOTITLE](/codespaces/troubleshooting/troubleshooting-included-usage#storage-usage-for-your-base-dev-container)." diff --git a/data/reusables/codespaces/developing-in-vscode.md b/data/reusables/codespaces/developing-in-vscode.md index 52f046a1c4cb..875795b4c94e 100644 --- a/data/reusables/codespaces/developing-in-vscode.md +++ b/data/reusables/codespaces/developing-in-vscode.md @@ -4,7 +4,7 @@ You can customize the codespaces that are created for a repository by creating o ### Personalizing your codespace -You can use a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to personalize aspects of the codespace environment for any codespace that you create. Personalization can include shell preferences and additional tools. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account)." +You can use a [dotfiles](https://dotfiles.github.io/tutorials/) repository and [Settings Sync](https://code.visualstudio.com/docs/editor/settings-sync) to personalize aspects of the codespace environment for any codespace that you create. Personalization can include shell preferences and additional tools. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account)." ### Running your app from a codespace diff --git a/data/reusables/codespaces/disabling-settings-sync.md b/data/reusables/codespaces/disabling-settings-sync.md index 783b10435981..a06c04533333 100644 --- a/data/reusables/codespaces/disabling-settings-sync.md +++ b/data/reusables/codespaces/disabling-settings-sync.md @@ -4,7 +4,7 @@ When you turn off Settings Sync in a codespace, new codespaces continue to use t If you want to return to using the default {% data variables.product.prodname_vscode_shortname %} settings in all instances of {% data variables.product.prodname_vscode_shortname %}, including the desktop application, you can clear the cache in the cloud when you turn off Settings Sync. -1. If Settings Sync is currently turned off in your instance of {% data variables.product.prodname_vscode_shortname %}, and you want to clear your cached settings, you must first turn it on. For instructions, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#turning-on-settings-sync-in-a-codespace)." +1. If Settings Sync is currently turned off in your instance of {% data variables.product.prodname_vscode_shortname %}, and you want to clear your cached settings, you must first turn it on. For instructions, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#turning-on-settings-sync-in-a-codespace)." 1. At the bottom of the Activity Bar, select {% octicon "gear" aria-label="The gear icon" %} and click **Settings Sync is On**. 1. In the dropdown, click **Settings Sync: Turn Off**. diff --git a/data/reusables/codespaces/jupyterlab-in-default-image.md b/data/reusables/codespaces/jupyterlab-in-default-image.md index 28bcf72d3e52..42569d5626b1 100644 --- a/data/reusables/codespaces/jupyterlab-in-default-image.md +++ b/data/reusables/codespaces/jupyterlab-in-default-image.md @@ -1 +1 @@ -The default container image includes JupyterLab, so codespaces created from the default image will always have JupyterLab installed. For more information about the default image, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration)" and [the `devcontainers/images` repository](https://github.com/devcontainers/images/tree/main/src/universal). If you're not using the default image in your dev container configuration, you can install JupyterLab by adding the `ghcr.io/devcontainers/features/python` feature to your `devcontainer.json` file. You should include the option `"installJupyterlab": true`. For more information, see [the README for the `python` feature](https://github.com/devcontainers/features/tree/main/src/python#python-python), in the `devcontainers/features` repository. +The default dev container image includes JupyterLab, so codespaces created from the default image will always have JupyterLab installed. For more information about the default image, see "[AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers#using-the-default-dev-container-configuration)" and [the `devcontainers/images` repository](https://github.com/devcontainers/images/tree/main/src/universal). If you're not using the default image in your dev container configuration, you can install JupyterLab by adding the `ghcr.io/devcontainers/features/python` feature to your `devcontainer.json` file. You should include the option `"installJupyterlab": true`. For more information, see [the README for the `python` feature](https://github.com/devcontainers/features/tree/main/src/python#python-python), in the `devcontainers/features` repository. diff --git a/data/reusables/codespaces/settings-sync-link.md b/data/reusables/codespaces/settings-sync-link.md index a2cc47ae22e4..576d20ba6953 100644 --- a/data/reusables/codespaces/settings-sync-link.md +++ b/data/reusables/codespaces/settings-sync-link.md @@ -1 +1 @@ -You can use Settings Sync to share these settings across all codespaces you open in the {% data variables.product.prodname_vscode_shortname %} web client and desktop application. If you're working in the web client, Settings Sync is disabled by default, and you must enable Settings Sync to push changes to your settings or pull in new changes you have made elsewhere. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#settings-sync)." +You can use Settings Sync to share these settings across all codespaces you open in the {% data variables.product.prodname_vscode_shortname %} web client and desktop application. If you're working in the web client, Settings Sync is disabled by default, and you must enable Settings Sync to push changes to your settings or pull in new changes you have made elsewhere. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#settings-sync)." diff --git a/data/reusables/codespaces/ssh-server-installed.md b/data/reusables/codespaces/ssh-server-installed.md index b1eae8b97251..885fddf5776e 100644 --- a/data/reusables/codespaces/ssh-server-installed.md +++ b/data/reusables/codespaces/ssh-server-installed.md @@ -1,4 +1,4 @@ -The codespace you connect to must be running an SSH server. The default container image includes an SSH server, which is started automatically. If your codespaces are not created from the default image, you can install and start an SSH server by adding the following to the `features` object in your `devcontainer.json` file. +The codespace you connect to must be running an SSH server. The default dev container image includes an SSH server, which is started automatically. If your codespaces are not created from the default image, you can install and start an SSH server by adding the following to the `features` object in your `devcontainer.json` file. ```jsonc "features": { diff --git a/data/reusables/codespaces/troubleshooting-simple-browser.md b/data/reusables/codespaces/troubleshooting-simple-browser.md index e3a0774a96a6..f9228720b783 100644 --- a/data/reusables/codespaces/troubleshooting-simple-browser.md +++ b/data/reusables/codespaces/troubleshooting-simple-browser.md @@ -41,7 +41,7 @@ To implement the port configuration specified in `devcontainer.json`, {% data va } ``` -If the `settings.json` file doesn't contain these settings, check whether you have dotfiles enabled, and whether any configuration in your dotfiles is overwriting the `settings.json` file. For more information, see "[AUTOTITLE](/codespaces/customizing-your-codespace/personalizing-github-codespaces-for-your-account#dotfiles)." +If the `settings.json` file doesn't contain these settings, check whether you have dotfiles enabled, and whether any configuration in your dotfiles is overwriting the `settings.json` file. For more information, see "[AUTOTITLE](/codespaces/setting-your-user-preferences/personalizing-github-codespaces-for-your-account#dotfiles)." #### The application does not load diff --git a/data/reusables/codespaces/workspaces-directory.md b/data/reusables/codespaces/workspaces-directory.md index 3f3372a92a47..53f100e79da4 100644 --- a/data/reusables/codespaces/workspaces-directory.md +++ b/data/reusables/codespaces/workspaces-directory.md @@ -1,5 +1,5 @@ When you create a codespace, your repository is cloned into the `/workspaces` directory in your codespace. This is a persistent directory that is mounted into the container. Any changes you make inside this directory, including editing, adding, or deleting files, are preserved when you stop and start the codespace, and when you rebuild the container in the codespace. -Outside the `/workspaces` directory, your codespace contains a Linux directory structure that varies depending on the image used to build your codespace. You can add files or make changes to files outside the `/workspaces` directory: for example, you can install new programs, or you can set up your shell configuration in a file such as `~/.bashrc`. As a non-root user, you may not automatically have write access to certain directories, but most images allow root access to these directories with the `sudo` command. +Outside the `/workspaces` directory, your codespace contains a Linux directory structure that varies depending on the dev container image used to build your codespace. You can add files or make changes to files outside the `/workspaces` directory: for example, you can install new programs, or you can set up your shell configuration in a file such as `~/.bashrc`. As a non-root user, you may not automatically have write access to certain directories, but most images allow root access to these directories with the `sudo` command. -Outside `/workspaces`, with the exception of the `/tmp` directory, the directories in a codespace are tied to the lifecycle of the container. This means any changes you make are preserved when you stop and start your codespace, but are not preserved when you rebuild of the container. +Outside `/workspaces`, with the exception of the `/tmp` directory, the directories in a codespace are tied to the lifecycle of the container. This means any changes you make are preserved when you stop and start your codespace, but are not preserved when you rebuild the container. diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md index bea87909f03f..d4fac8a80c19 100644 --- a/data/reusables/dependabot/supported-package-managers.md +++ b/data/reusables/dependabot/supported-package-managers.md @@ -18,7 +18,7 @@ Go modules | `gomod` | v1 | {% octicon "check" aria-l [Gradle](#gradle) | `gradle` | Not applicable | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | [Maven](#maven) | `maven` | Not applicable | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | npm | `npm` | v6, v7, v8, v9 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | -[NuGet](#nuget-cli) | `nuget` | <= 4.8 | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | +[NuGet](#nuget-cli) | `nuget` | {% ifversion dependabot-updates-enhanced-nuget-support %}<= 6.7.0{% else %}<= 4.8{% endif %} | {% octicon "check" aria-label="Supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% ifversion dependabot-PEP621-support %}[pip](#pip-and-pip-compile){% else %}pip{% endif %} | `pip` | v21.1.2 | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | pipenv | `pip` | <= 2021-05-29 | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | {% ifversion dependabot-PEP621-support %}[pip-compile](#pip-and-pip-compile){% else %}pip-compile{% endif %} | `pip` | 6.1.0 | {% octicon "x" aria-label="Not supported" %} | {% octicon "check" aria-label="Supported" %} | {% octicon "x" aria-label="Not supported" %} | @@ -88,7 +88,7 @@ For {% data variables.product.prodname_dependabot_security_updates %}, Gradle su #### NuGet CLI -{% data variables.product.prodname_dependabot %} doesn't run the NuGet CLI but does support most features up until version 4.8. +{% data variables.product.prodname_dependabot %} doesn't run the NuGet CLI but does support most features up until version {% ifversion dependabot-updates-enhanced-nuget-support %}6.7.0{% else %}4.8{% endif %}. {% ifversion dependabot-PEP621-support %} diff --git a/data/ui.yml b/data/ui.yml index 64fdc1563910..406f98bee659 100644 --- a/data/ui.yml +++ b/data/ui.yml @@ -225,10 +225,6 @@ product_guides: load_more: Load more guides all_guides_title: 'All {{ name }} guides' filter_instructions: Filter the guide list using these controls - filters: - type: Type - topic: Topic - all: All guides_found: multiple: '{n} guides found' one: 1 guide found diff --git a/package-lock.json b/package-lock.json index ebefb3b3d449..95aa39144369 100644 --- a/package-lock.json +++ b/package-lock.json @@ -64,7 +64,7 @@ "mdast-util-to-markdown": "2.0.0", "mdast-util-to-string": "^4.0.0", "morgan": "^1.10.0", - "next": "14.0.2", + "next": "14.0.3", "ora": "^7.0.1", "parse5": "7.1.2", "port-used": "^2.0.8", @@ -1886,14 +1886,14 @@ "license": "BSD-3-Clause" }, "node_modules/@next/env": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/@next/env/-/env-14.0.2.tgz", - "integrity": "sha512-HAW1sljizEaduEOes/m84oUqeIDAUYBR1CDwu2tobNlNDFP3cSm9d6QsOsGeNlIppU1p/p1+bWbYCbvwjFiceA==" + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/@next/env/-/env-14.0.3.tgz", + "integrity": "sha512-7xRqh9nMvP5xrW4/+L0jgRRX+HoNRGnfJpD+5Wq6/13j3dsdzxO3BCXn7D3hMqsDb+vjZnJq+vI7+EtgrYZTeA==" }, "node_modules/@next/swc-darwin-arm64": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/@next/swc-darwin-arm64/-/swc-darwin-arm64-14.0.2.tgz", - "integrity": "sha512-i+jQY0fOb8L5gvGvojWyZMfQoQtDVB2kYe7fufOEiST6sicvzI2W5/EXo4lX5bLUjapHKe+nFxuVv7BA+Pd7LQ==", + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/@next/swc-darwin-arm64/-/swc-darwin-arm64-14.0.3.tgz", + "integrity": "sha512-64JbSvi3nbbcEtyitNn2LEDS/hcleAFpHdykpcnrstITFlzFgB/bW0ER5/SJJwUPj+ZPY+z3e+1jAfcczRLVGw==", "cpu": [ "arm64" ], @@ -1906,9 +1906,9 @@ } }, "node_modules/@next/swc-darwin-x64": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/@next/swc-darwin-x64/-/swc-darwin-x64-14.0.2.tgz", - "integrity": "sha512-zRCAO0d2hW6gBEa4wJaLn+gY8qtIqD3gYd9NjruuN98OCI6YyelmhWVVLlREjS7RYrm9OUQIp/iVJFeB6kP1hg==", + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/@next/swc-darwin-x64/-/swc-darwin-x64-14.0.3.tgz", + "integrity": "sha512-RkTf+KbAD0SgYdVn1XzqE/+sIxYGB7NLMZRn9I4Z24afrhUpVJx6L8hsRnIwxz3ERE2NFURNliPjJ2QNfnWicQ==", "cpu": [ "x64" ], @@ -1921,9 +1921,9 @@ } }, "node_modules/@next/swc-linux-arm64-gnu": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-gnu/-/swc-linux-arm64-gnu-14.0.2.tgz", - "integrity": "sha512-tSJmiaon8YaKsVhi7GgRizZoV0N1Sx5+i+hFTrCKKQN7s3tuqW0Rov+RYdPhAv/pJl4qiG+XfSX4eJXqpNg3dA==", + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-gnu/-/swc-linux-arm64-gnu-14.0.3.tgz", + "integrity": "sha512-3tBWGgz7M9RKLO6sPWC6c4pAw4geujSwQ7q7Si4d6bo0l6cLs4tmO+lnSwFp1Tm3lxwfMk0SgkJT7EdwYSJvcg==", "cpu": [ "arm64" ], @@ -1936,9 +1936,9 @@ } }, "node_modules/@next/swc-linux-arm64-musl": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-musl/-/swc-linux-arm64-musl-14.0.2.tgz", - "integrity": "sha512-dXJLMSEOwqJKcag1BeX1C+ekdPPJ9yXbWIt3nAadhbLx5CjACoB2NQj9Xcqu2tmdr5L6m34fR+fjGPs+ZVPLzA==", + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/@next/swc-linux-arm64-musl/-/swc-linux-arm64-musl-14.0.3.tgz", + "integrity": "sha512-v0v8Kb8j8T23jvVUWZeA2D8+izWspeyeDGNaT2/mTHWp7+37fiNfL8bmBWiOmeumXkacM/AB0XOUQvEbncSnHA==", "cpu": [ "arm64" ], @@ -1951,9 +1951,9 @@ } }, "node_modules/@next/swc-linux-x64-gnu": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-gnu/-/swc-linux-x64-gnu-14.0.2.tgz", - "integrity": "sha512-WC9KAPSowj6as76P3vf1J3mf2QTm3Wv3FBzQi7UJ+dxWjK3MhHVWsWUo24AnmHx9qDcEtHM58okgZkXVqeLB+Q==", + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-gnu/-/swc-linux-x64-gnu-14.0.3.tgz", + "integrity": "sha512-VM1aE1tJKLBwMGtyBR21yy+STfl0MapMQnNrXkxeyLs0GFv/kZqXS5Jw/TQ3TSUnbv0QPDf/X8sDXuMtSgG6eg==", "cpu": [ "x64" ], @@ -1966,9 +1966,9 @@ } }, "node_modules/@next/swc-linux-x64-musl": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-musl/-/swc-linux-x64-musl-14.0.2.tgz", - "integrity": "sha512-KSSAwvUcjtdZY4zJFa2f5VNJIwuEVnOSlqYqbQIawREJA+gUI6egeiRu290pXioQXnQHYYdXmnVNZ4M+VMB7KQ==", + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/@next/swc-linux-x64-musl/-/swc-linux-x64-musl-14.0.3.tgz", + "integrity": "sha512-64EnmKy18MYFL5CzLaSuUn561hbO1Gk16jM/KHznYP3iCIfF9e3yULtHaMy0D8zbHfxset9LTOv6cuYKJgcOxg==", "cpu": [ "x64" ], @@ -1981,9 +1981,9 @@ } }, "node_modules/@next/swc-win32-arm64-msvc": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/@next/swc-win32-arm64-msvc/-/swc-win32-arm64-msvc-14.0.2.tgz", - "integrity": "sha512-2/O0F1SqJ0bD3zqNuYge0ok7OEWCQwk55RPheDYD0va5ij7kYwrFkq5ycCRN0TLjLfxSF6xI5NM6nC5ux7svEQ==", + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/@next/swc-win32-arm64-msvc/-/swc-win32-arm64-msvc-14.0.3.tgz", + "integrity": "sha512-WRDp8QrmsL1bbGtsh5GqQ/KWulmrnMBgbnb+59qNTW1kVi1nG/2ndZLkcbs2GX7NpFLlToLRMWSQXmPzQm4tog==", "cpu": [ "arm64" ], @@ -1996,9 +1996,9 @@ } }, "node_modules/@next/swc-win32-ia32-msvc": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/@next/swc-win32-ia32-msvc/-/swc-win32-ia32-msvc-14.0.2.tgz", - "integrity": "sha512-vJI/x70Id0oN4Bq/R6byBqV1/NS5Dl31zC+lowO8SDu1fHmUxoAdILZR5X/sKbiJpuvKcCrwbYgJU8FF/Gh50Q==", + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/@next/swc-win32-ia32-msvc/-/swc-win32-ia32-msvc-14.0.3.tgz", + "integrity": "sha512-EKffQeqCrj+t6qFFhIFTRoqb2QwX1mU7iTOvMyLbYw3QtqTw9sMwjykyiMlZlrfm2a4fA84+/aeW+PMg1MjuTg==", "cpu": [ "ia32" ], @@ -2011,9 +2011,9 @@ } }, "node_modules/@next/swc-win32-x64-msvc": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/@next/swc-win32-x64-msvc/-/swc-win32-x64-msvc-14.0.2.tgz", - "integrity": "sha512-Ut4LXIUvC5m8pHTe2j0vq/YDnTEyq6RSR9vHYPqnELrDapPhLNz9Od/L5Ow3J8RNDWpEnfCiQXuVdfjlNEJ7ug==", + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/@next/swc-win32-x64-msvc/-/swc-win32-x64-msvc-14.0.3.tgz", + "integrity": "sha512-ERhKPSJ1vQrPiwrs15Pjz/rvDHZmkmvbf/BjPN/UCOI++ODftT0GtasDPi0j+y6PPJi5HsXw+dpRaXUaw4vjuQ==", "cpu": [ "x64" ], @@ -11222,11 +11222,11 @@ } }, "node_modules/next": { - "version": "14.0.2", - "resolved": "https://registry.npmjs.org/next/-/next-14.0.2.tgz", - "integrity": "sha512-jsAU2CkYS40GaQYOiLl9m93RTv2DA/tTJ0NRlmZIBIL87YwQ/xR8k796z7IqgM3jydI8G25dXvyYMC9VDIevIg==", + "version": "14.0.3", + "resolved": "https://registry.npmjs.org/next/-/next-14.0.3.tgz", + "integrity": "sha512-AbYdRNfImBr3XGtvnwOxq8ekVCwbFTv/UJoLwmaX89nk9i051AEY4/HAWzU0YpaTDw8IofUpmuIlvzWF13jxIw==", "dependencies": { - "@next/env": "14.0.2", + "@next/env": "14.0.3", "@swc/helpers": "0.5.2", "busboy": "1.6.0", "caniuse-lite": "^1.0.30001406", @@ -11241,15 +11241,15 @@ "node": ">=18.17.0" }, "optionalDependencies": { - "@next/swc-darwin-arm64": "14.0.2", - "@next/swc-darwin-x64": "14.0.2", - "@next/swc-linux-arm64-gnu": "14.0.2", - "@next/swc-linux-arm64-musl": "14.0.2", - "@next/swc-linux-x64-gnu": "14.0.2", - "@next/swc-linux-x64-musl": "14.0.2", - "@next/swc-win32-arm64-msvc": "14.0.2", - "@next/swc-win32-ia32-msvc": "14.0.2", - "@next/swc-win32-x64-msvc": "14.0.2" + "@next/swc-darwin-arm64": "14.0.3", + "@next/swc-darwin-x64": "14.0.3", + "@next/swc-linux-arm64-gnu": "14.0.3", + "@next/swc-linux-arm64-musl": "14.0.3", + "@next/swc-linux-x64-gnu": "14.0.3", + "@next/swc-linux-x64-musl": "14.0.3", + "@next/swc-win32-arm64-msvc": "14.0.3", + "@next/swc-win32-ia32-msvc": "14.0.3", + "@next/swc-win32-x64-msvc": "14.0.3" }, "peerDependencies": { "@opentelemetry/api": "^1.1.0", diff --git a/package.json b/package.json index 6ab3f8d18bc0..df5f9dd08062 100644 --- a/package.json +++ b/package.json @@ -261,7 +261,7 @@ "mdast-util-to-markdown": "2.0.0", "mdast-util-to-string": "^4.0.0", "morgan": "^1.10.0", - "next": "14.0.2", + "next": "14.0.3", "ora": "^7.0.1", "parse5": "7.1.2", "port-used": "^2.0.8", diff --git a/src/audit-logs/scripts/sync.js b/src/audit-logs/scripts/sync.js index 9ac772e023e4..6606bdba7cd6 100755 --- a/src/audit-logs/scripts/sync.js +++ b/src/audit-logs/scripts/sync.js @@ -180,6 +180,24 @@ async function main() { } }) + // We don't maintain the order of events as we process them so after filtering + // all the events based on their allowlist values, we sort them so they're in + // order for display on the audit log pages. + for (const pageType of Object.values(auditLogData)) { + for (const events of Object.values(pageType)) { + events.sort((e1, e2) => { + // Event actions have underscores and periods (e.g. + // `enterprise.runner_group_runners_updated`) and we ignore them both + // so that for example `org_secret_scanning_custom_pattern.update` is + // treated as `org secrect scanning custom pattern update` and will be + // sorted after `org.accept_business_invitation`. + const a1 = e1.action.replace(/[_.]/g, ' ') + const a2 = e2.action.replace(/[_.]/g, ' ') + return a1.localeCompare(a2) + }) + } + } + console.log(`\n▶️ Generating audit log data files...\n`) // write out audit log event data to page event files per version e.g.: diff --git a/src/content-linter/tests/lint-frontmatter.js b/src/content-linter/tests/lint-frontmatter.js index 1108ee22fb8a..452332a32a7b 100644 --- a/src/content-linter/tests/lint-frontmatter.js +++ b/src/content-linter/tests/lint-frontmatter.js @@ -45,6 +45,16 @@ describe('front matter', () => { const customErrorMessage = makeCustomErrorMessage(page, trouble, 'includeGuides') expect(trouble.length, customErrorMessage).toEqual(0) + + const counts = new Map() + for (const guide of page.includeGuides) { + counts.set(guide, (counts.get(guide) || 0) + 1) + } + const countUnique = counts.size + let notDistinctMessage = `In ${page.relativePath} there are duplicate links in .includeGuides` + const dupes = [...counts.entries()].filter(([, count]) => count > 1).map(([entry]) => entry) + notDistinctMessage += `\nTo fix this, remove: ${dupes.join(' and ')}` + expect(page.includeGuides.length, notDistinctMessage).toEqual(countUnique) }, ) diff --git a/src/fixtures/fixtures/data/ui.yml b/src/fixtures/fixtures/data/ui.yml index 64fdc1563910..406f98bee659 100644 --- a/src/fixtures/fixtures/data/ui.yml +++ b/src/fixtures/fixtures/data/ui.yml @@ -225,10 +225,6 @@ product_guides: load_more: Load more guides all_guides_title: 'All {{ name }} guides' filter_instructions: Filter the guide list using these controls - filters: - type: Type - topic: Topic - all: All guides_found: multiple: '{n} guides found' one: 1 guide found diff --git a/src/frame/lib/page.js b/src/frame/lib/page.js index 37f8c18bf5f3..0658db76f22f 100644 --- a/src/frame/lib/page.js +++ b/src/frame/lib/page.js @@ -13,7 +13,6 @@ import slash from 'slash' import readFileContents from './read-file-contents.js' import getLinkData from '#src/learning-track/lib/get-link-data.js' import getDocumentType from '#src/events/lib/get-document-type.js' -import { union } from 'lodash-es' import { allTools } from '#src/tools/lib/all-tools.js' import { renderContentWithFallback } from '#src/languages/lib/render-with-fallback.js' import { deprecated, supported } from '#src/versions/lib/enterprise-server-releases.js' @@ -254,15 +253,11 @@ class Page { } if (this.rawIncludeGuides) { - this.allTopics = [] this.includeGuides = await getLinkData(this.rawIncludeGuides, context) this.includeGuides.map((guide) => { const { page } = guide guide.type = page.type if (page.topics) { - this.allTopics = union(this.allTopics, page.topics).sort((a, b) => - a.localeCompare(b, page.languageCode), - ) guide.topics = page.topics } delete guide.page diff --git a/src/landings/components/ArticleCards.tsx b/src/landings/components/ArticleCards.tsx index bbf8b3faae47..832ace6bae39 100644 --- a/src/landings/components/ArticleCards.tsx +++ b/src/landings/components/ArticleCards.tsx @@ -3,28 +3,15 @@ import React, { useRef } from 'react' import { useProductGuidesContext } from 'src/landings/components/ProductGuidesContext' import { useTranslation } from 'src/languages/components/useTranslation' import { ArticleCard } from './ArticleCard' -import { ItemInput } from '@primer/react/lib/deprecated/ActionList/List' export const ArticleCards = () => { const { t, tObject } = useTranslation('product_guides') const guideTypes = tObject('guide_types') - const { allTopics, includeGuides } = useProductGuidesContext() + const { includeGuides } = useProductGuidesContext() const articleCardRef = useRef(null) const guides = includeGuides || [] - const types = Object.entries(guideTypes).map(([key, val]) => { - return { text: val, key } - }) as ItemInput[] - - types.unshift({ text: t('filters.all'), key: undefined }) - - const topics = allTopics?.map((topic) => { - return { text: topic, key: topic } - }) as ItemInput[] - - topics.unshift({ text: t('filters.all'), key: undefined }) - return (
diff --git a/src/landings/components/ProductGuidesContext.tsx b/src/landings/components/ProductGuidesContext.tsx index aa8c274250f5..b16977735cb3 100644 --- a/src/landings/components/ProductGuidesContext.tsx +++ b/src/landings/components/ProductGuidesContext.tsx @@ -22,7 +22,6 @@ export type ProductGuidesContextT = { intro: string learningTracks?: Array includeGuides?: Array - allTopics?: Array } export const ProductGuidesContext = createContext(null) @@ -43,7 +42,7 @@ export const getProductGuidesContextFromRequest = (req: any): ProductGuidesConte const page = req.context.page return { - ...pick(page, ['title', 'intro', 'allTopics']), + ...pick(page, ['title', 'intro']), learningTracks: (page.learningTracks || []).map((track: any) => ({ ...pick(track, ['title', 'description', 'trackName', 'trackProduct']), guides: (track.guides || []).map((guide: any) => { diff --git a/src/shielding/middleware/handle-invalid-paths.js b/src/shielding/middleware/handle-invalid-paths.js index ee9b39a9f7bc..13ce9f04464f 100644 --- a/src/shielding/middleware/handle-invalid-paths.js +++ b/src/shielding/middleware/handle-invalid-paths.js @@ -9,6 +9,7 @@ const JUNK_PATHS = new Set([ '/server.js', '/package.json', '/.git', + '/_next', ]) // Basename is the last token of the path when split by `/`. diff --git a/src/shielding/tests/shielding.js b/src/shielding/tests/shielding.js index 8edaff43acfc..8be51dab5868 100644 --- a/src/shielding/tests/shielding.js +++ b/src/shielding/tests/shielding.js @@ -41,6 +41,11 @@ describe('junk paths', () => { expect(res.statusCode).toBe(302) expect(res.headers.location).toBe('/en/get-started') }) + + test('just _next', async () => { + const res = await get('/_next') + expect(res.statusCode).toBe(404) + }) }) describe('rate limiting', () => {