You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: content/admin/data-residency/feature-overview-for-github-enterprise-cloud-with-data-residency.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ The following features are currently unavailable on {% data variables.enterprise
20
20
21
21
| Feature | Details | More information |
22
22
| :- | :- | :- |
23
-
| {% data variables.product.prodname_github_codespaces %} | Currently unavailable. |[AUTOTITLE](/codespaces/overview)|
23
+
| {% data variables.product.prodname_github_codespaces %} | Currently unavailable. |[AUTOTITLE](/codespaces/quickstart)|
24
24
| {% data variables.product.prodname_marketplace %} | Currently, apps from {% data variables.product.prodname_marketplace %} are unavailable. {% data variables.product.prodname_actions %} workflows from {% data variables.product.prodname_marketplace %} may not function as expected. For more information, see [GitHub Actions workflows from GitHub Marketplace](#github-actions-workflows-from-github-marketplace). |[AUTOTITLE](/search-github/searching-on-github/searching-github-marketplace)|[AUTOTITLE](/enterprise-server@latest/admin/configuration/configuring-github-connect/about-github-connect#github-connect-features) in the {% data variables.product.prodname_ghe_server %} documentation |
25
25
| macOS runners for {% data variables.product.prodname_actions %} | Currently unavailable. |[AUTOTITLE](/actions/using-github-hosted-runners/about-github-hosted-runners/about-github-hosted-runners)|
26
26
| Maven and Gradle support for {% data variables.product.prodname_registry %} | Currently unavailable. |[AUTOTITLE](/packages/working-with-a-github-packages-registry/working-with-the-apache-maven-registry)|
Copy file name to clipboardexpand all lines: content/authentication/keeping-your-account-and-data-secure/reviewing-your-security-log.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -34,7 +34,7 @@ The events listed in your security log are triggered by your actions. Actions ar
34
34
| ------------- | ----------- |
35
35
| {% ifversion fpt or ghec %} |
36
36
|`billing`| Contains all activities related to your billing information. |
37
-
|`codespaces`| Contains all activities related to {% data variables.product.prodname_github_codespaces %}. For more information, see [AUTOTITLE](/codespaces/overview). |
37
+
|`codespaces`| Contains all activities related to {% data variables.product.prodname_github_codespaces %}. For more information, see [AUTOTITLE](/codespaces/quickstart). |
38
38
|`copilot`| Contains all activities related to {% data variables.product.prodname_copilot_business_short %}. For more information, see [AUTOTITLE](/copilot/about-github-copilot/what-is-github-copilot). |
39
39
|`marketplace_agreement_signature`| Contains all activities related to signing the {% data variables.product.prodname_marketplace %} Developer Agreement. |
40
40
|`marketplace_listing`| Contains all activities related to listing apps in {% data variables.product.prodname_marketplace %}. |
intro: 'Learn about what GitHub Codespaces offer.'
6
+
versions:
7
+
fpt: '*'
8
+
ghec: '*'
9
+
type: overview
10
+
topics:
11
+
- Codespaces
12
+
- Developer
13
+
---
14
+
15
+
## {% data variables.product.prodname_github_codespaces %} features
16
+
17
+
### Preconfigured development environments
18
+
19
+
You can work in a development environment that has been specifically configured for the repository. It will have all of the tools, languages, and configurations you need to work on that project. Everyone who works on that repository in a codespace will have the same environment. This reduces the likelihood of environment-related problems occurring and being difficult to debug. Each repository can have settings that will give contributors a ready-to-use, fit-for-purpose environment, and the environment on your local machine will be unchanged.
20
+
21
+
### Access the resources you need
22
+
23
+
Your local computer may not have the processing power, or storage space, you need to work on a project. {% data variables.product.prodname_github_codespaces %} allows you to work remotely on a machine with adequate resources.
24
+
25
+
### Work anywhere
26
+
27
+
All you need is a web browser. You can work in a codespace on your own computer, on a friend's laptop, or on a tablet. Open your codespace and pick up from where you left off on a different device.
28
+
29
+
### Choose your editor
30
+
31
+
Work in the browser, using the {% data variables.product.prodname_vscode_shortname %} web client or JupyterLab, or in the desktop-based {% data variables.product.prodname_vscode_shortname %} application.
32
+
33
+
### Work on multiple projects
34
+
35
+
You can use multiple codespaces to work on separate projects, or on different branches of the same repository, compartmentalizing your work to avoid changes made for one piece of work accidentally affecting something else you're working on.
36
+
37
+
### Pair program with a teammate
38
+
39
+
If you work on a codespace in {% data variables.product.prodname_vscode_shortname %}, you can use Live Share to work collaboratively with other people on your team. See [AUTOTITLE](/codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace).
40
+
41
+
### Publish your web app from a codespace
42
+
43
+
Forward a port from your codespace and then share the URL, to allow teammates to try out the changes you've made to the application before you submit those changes in a pull request.
44
+
45
+
### Try out a framework
46
+
47
+
{% data variables.product.prodname_github_codespaces %} reduces the setup time when you want to learn a new framework. Just create a codespace from one of the [quickstart templates](https://github.com/codespaces/templates).
Copy file name to clipboardexpand all lines: content/codespaces/about-codespaces/deep-dive.md
+4-2
Original file line number
Diff line number
Diff line change
@@ -1,14 +1,16 @@
1
1
---
2
2
title: 'Deep dive into {% data variables.product.prodname_github_codespaces %}'
3
3
shortTitle: 'Deep dive into {% data variables.product.prodname_codespaces %}'
4
-
intro: 'Understand how {% data variables.product.prodname_github_codespaces %} works.'
4
+
intro: 'Explore more detail about how {% data variables.product.prodname_github_codespaces %} work.'
5
5
allowTitleToDifferFromFilename: true
6
6
versions:
7
7
fpt: '*'
8
8
ghec: '*'
9
9
type: quick_start
10
10
topics:
11
11
- Codespaces
12
+
redirect_from:
13
+
- /codespaces/getting-started/deep-dive
12
14
---
13
15
14
16
{% data variables.product.prodname_github_codespaces %} is an instant, cloud-based development environment that uses a container to provide you with common languages, tools, and utilities for development. {% data variables.product.prodname_github_codespaces %} is also configurable, allowing you to create a customized development environment for your project. By configuring a custom development environment for your project, you can have a repeatable codespace configuration for all users of your project.
@@ -150,4 +152,4 @@ If you want to make changes to your codespace that will be more robust over rebu
Copy file name to clipboardexpand all lines: content/codespaces/about-codespaces/understanding-the-codespace-lifecycle.md
+4-3
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
1
---
2
2
title: Understanding the codespace lifecycle
3
3
shortTitle: The codespace lifecycle
4
-
intro: 'You can develop in a {% data variables.product.prodname_github_codespaces %} environment and maintain your data throughout the entire codespace lifecycle.'
4
+
intro: 'Learn how to develop in a {% data variables.product.prodname_github_codespaces %} environment, and maintain your data throughout the entire codespace lifecycle.'
> This article explains the stages in the life of a codespace, from creation to deletion. If you have read the [AUTOTITLE](/codespaces/getting-started/quickstart) article and you now want to start using {% data variables.product.prodname_github_codespaces %} for your own work, see the articles under [AUTOTITLE](/codespaces/developing-in-a-codespace).
20
+
> This article explains the stages in the life of a codespace, from creation to deletion. If you have read the [AUTOTITLE](/codespaces/quickstart) article and you now want to start using {% data variables.product.prodname_github_codespaces %} for your own work, see the articles under [AUTOTITLE](/codespaces/developing-in-a-codespace).
A codespace is a development environment that's hosted in the cloud. You can customize your project for {% data variables.product.prodname_github_codespaces %} by committing configuration files to your repository (often known as Configuration-as-Code), which creates a repeatable codespace configuration for all users of your project. See [AUTOTITLE](/codespaces/setting-up-your-project-for-codespaces/adding-a-dev-container-configuration/introduction-to-dev-containers).
29
25
@@ -35,19 +31,6 @@ You can connect to your codespaces from your browser, from {% data variables.pro
35
31
36
32
37
33
38
-
## Benefits of {% data variables.product.prodname_github_codespaces %}
39
-
40
-
Reasons for choosing to work in a codespace include:
41
-
42
-
***Use a preconfigured development environment** - You can work in a development environment that has been specifically configured for the repository. It will have all of the tools, languages, and configurations you need to work on that project. Everyone who works on that repository in a codespace will have the same environment. This reduces the likelihood of environment-related problems occurring and being difficult to debug. Each repository can have settings that will give contributors a ready-to-use, fit-for-purpose environment, and the environment on your local machine will be unchanged.
43
-
***Access the resources you need** - Your local computer may not have the processing power, or storage space, you need to work on a project. {% data variables.product.prodname_github_codespaces %} allows you to work remotely on a machine with adequate resources.
44
-
***Work anywhere** - All you need is a web browser. You can work in a codespace on your own computer, on a friend's laptop, or on a tablet. Open your codespace and pick up from where you left off on a different device.
45
-
***Choose your editor** - Work in the browser in the {% data variables.product.prodname_vscode_shortname %} web client, or choose from a selection of desktop-based applications.
46
-
***Work on multiple projects** - You can use multiple codespaces to work on separate projects, or on different branches of the same repository, compartmentalizing your work to avoid changes made for one piece of work accidentally affecting something else you're working on.
47
-
***Pair program with a teammate** - If you work on a codespace in {% data variables.product.prodname_vscode_shortname %}, you can use Live Share to work collaboratively with other people on your team. See [AUTOTITLE](/codespaces/developing-in-a-codespace/working-collaboratively-in-a-codespace).
48
-
***Publish your web app from a codespace** - Forward a port from your codespace and then share the URL, to allow teammates to try out the changes you've made to the application before you submit those changes in a pull request.
49
-
***Try out a framework** - {% data variables.product.prodname_github_codespaces %} reduces the setup time when you want to learn a new framework. Just create a codespace from one of the [quickstart templates](https://github.com/codespaces/templates).
50
-
51
34
## Using {% data variables.product.prodname_github_codespaces %}
52
35
53
36
To begin developing using cloud-based compute resources, you can create a codespace from a template or from any branch or commit in a repository. When you create a codespace from a template, you can start from a blank template or choose a template suitable for the work you're doing.
Copy file name to clipboardexpand all lines: content/codespaces/customizing-your-codespace/changing-the-shell-in-a-codespace.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,7 @@ If you don't want to use the default shell, you can open a new terminal session
29
29
30
30
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.
31
31
32
-
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).
32
+
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/about-codespaces/deep-dive#about-the-directory-structure-of-a-codespace).
33
33
34
34
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).
35
35
@@ -119,7 +119,7 @@ When you have connected to the codespace, for most shells, you can use the comma
119
119
120
120
With most shells, you have the option of using a configuration file, such as `.bashrc`, to configure the shell with your preferred settings. These settings can include things like aliases and environment variables.
121
121
122
-
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).
122
+
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/about-codespaces/deep-dive#about-the-directory-structure-of-a-codespace).
123
123
124
124
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).
Copy file name to clipboardexpand all lines: content/codespaces/developing-in-a-codespace/creating-a-codespace-for-a-repository.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -55,9 +55,9 @@ When you create a codespace, a number of steps happen to create and connect you
55
55
* Step 3: You can connect to the codespace.
56
56
* Step 4: Codespace continues with post-creation setup.
57
57
58
-
For more information on what happens when you create a codespace, see [AUTOTITLE](/codespaces/getting-started/deep-dive).
58
+
For more information on what happens when you create a codespace, see [AUTOTITLE](/codespaces/about-codespaces/deep-dive).
59
59
60
-
For more information on the lifecycle of a codespace, see [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle).
60
+
For more information on the lifecycle of a codespace, see [AUTOTITLE](/codespaces/about-codespaces/understanding-the-codespace-lifecycle).
61
61
62
62
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.
Copy file name to clipboardexpand all lines: content/codespaces/developing-in-a-codespace/opening-an-existing-codespace.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ redirect_from:
20
20
21
21
{% endif %}
22
22
23
-
You can reopen any of your active or stopped codespaces on {% data variables.product.github %}, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. You can't reopen a codespace that has been deleted. See [AUTOTITLE](/codespaces/getting-started/understanding-the-codespace-lifecycle).
23
+
You can reopen any of your active or stopped codespaces on {% data variables.product.github %}, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. You can't reopen a codespace that has been deleted. See [AUTOTITLE](/codespaces/about-codespaces/understanding-the-codespace-lifecycle).
24
24
25
25
You can view all your codespaces on the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces). From this page, you can:
0 commit comments