jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-21 10:57:10 -05:00
Code Issues Projects Releases Wiki Activity

Codespaces support for JetBrains - review comment changes (#31483)

Browse Source
This commit is contained in:
hubwriter
2022-10-21 16:52:01 +01:00
committed by GitHub
parent 30ea40c9c6
commit 470e29e11a
38 changed files with 139 additions and 99 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
content/codespaces/developing-in-codespaces/using-github-codespaces-in-your-jetbrains-ide.md
View File

@@ -11,7 +11,6 @@ topics:
- Developer
---
## About {% data variables.product.prodname_codespaces %} in JetBrains IDEs
If you use a JetBrains IDE to work on your code, you can take advantage of working in a codespace. You do this by using the JetBrains Gateway application.
@@ -43,9 +42,13 @@ To work in a codespace in a JetBrains IDE you need:
* The JetBrains Gateway application
* {% data variables.product.prodname_cli %} version 2.2.0 or later
### JetBrains license
You must have a license to at least one of the supported JetBrains IDEs to connect to a codespace from the JetBrains Gateway.
### JetBrains Gateway
An easy way to install and update the JetBrains Gateway is from the JetBrains Toolbox application.
You can install and update the JetBrains Gateway from the JetBrains Toolbox application.
1. Download and install the [JetBrains Toolbox](https://www.jetbrains.com/toolbox-app).
1. Open the JetBrains Toolbox.
@@ -55,7 +58,7 @@ An easy way to install and update the JetBrains Gateway is from the JetBrains To
### {% data variables.product.prodname_cli %}
The {% data variables.product.prodname_github_codespaces %} plugin that's preinstalled in the JetBrains Gateway requires that you have installed and configured {% data variables.product.prodname_cli %} version 2.2.0 or later before opening a codespace from the JetBrains Gateway.
The {% data variables.product.prodname_github_codespaces %} plugin for the JetBrains Gateway requires that you have installed and configured {% data variables.product.prodname_cli %} version 2.2.0 or later before opening a codespace from the JetBrains Gateway.
Use this command to check your version of {% data variables.product.prodname_cli %}:
@@ -67,14 +70,15 @@ For more information, see "[About GitHub CLI](/github-cli/github-cli/about-githu
## Authenticating with {% data variables.product.prodname_cli %}
If you have not used {% data variables.product.prodname_cli %} before, you must authenticate with {% data variables.product.prodname_dotcom_the_website %}.
To use {% data variables.product.prodname_cli %} for {% data variables.product.prodname_github_codespaces %} you must authenticate with {% data variables.product.prodname_dotcom_the_website %}, specifying the `codespace` scope.
1. In a terminal window:
```shell{:copy}
gh auth login
gh auth login -h github.com -s codespace
```
1. If a prompt is displayed asking if you want to re-authenticate, type `y`.
1. Follow the prompts to complete the authentication process, choosing these options:
* What account do you want to log into? `{% data variables.product.prodname_dotcom_the_website %}`
* What is your preferred protocol for Git operations? `HTTPS`
@@ -87,24 +91,19 @@ If you have not used {% data variables.product.prodname_cli %} before, you must
## Setting up the JetBrains Gateway
The first time you use JetBrains Gateway for {% data variables.product.prodname_github_codespaces %}, you must supply the path to the installed {% data variables.product.prodname_cli %} executable. You must also allow the JetBrains Gateway to access {% data variables.product.prodname_dotcom_the_website %} using your {% data variables.product.prodname_dotcom %} account.
The first time you use JetBrains Gateway for {% data variables.product.prodname_github_codespaces %}, you must install the {% data variables.product.prodname_codespaces %} plugin. You must also allow the JetBrains Gateway to access {% data variables.product.prodname_dotcom_the_website %} using your {% data variables.product.prodname_dotcom %} account.
1. Find the path to the {% data variables.product.prodname_cli %} executable, for example by typing `which gh` (Linux/Mac) or `where.exe gh` (Windows) in a terminal window.
1. Open the JetBrains Gateway application.
1. Click **Connect to {% data variables.product.prodname_codespaces %}**.
1. Under **Install More Providers** click the **Install** link for {% data variables.product.prodname_github_codespaces %}.
![Screenshot of the JetBrains Gateway initial view](/assets/images/help/codespaces/jetbrains-gateway-connect.png)
**TODOCS -- ADD SCREENSHOT OF CODESPACES "INSTALL" OPTION - TO BE SUPPLIED BY JETBRAINS**
![Screenshot of the JetBrains Gateway initial view]()
1. In the "Welcome to JetBrains Gateway" dialog box, click the **{% data variables.product.prodname_dotcom %} {% data variables.product.prodname_codespaces %} settings** link.
1. Click **Connect to Codespace**.
![Screenshot of the prompt for the CLI path](/assets/images/help/codespaces/jetbrains-gateway-cli-setup.png)
![Screenshot of the Gateway with the 'Connect to Codespace' button](/assets/images/help/codespaces/jetbrains-gateway-connect.png)
1. Type the path to the {% data variables.product.prodname_cli %} executable, then click **OK**.
![Screenshot of the CLI path input dialog box](/assets/images/help/codespaces/jetbrains-gateway-cli-path.png)
1. Click **Connect to {% data variables.product.prodname_codespaces %}** again.
1. Click **Sign in with {% data variables.product.prodname_dotcom %}**.
1. In the "Welcome to JetBrains Gateway" dialog box, click **Sign In with {% data variables.product.prodname_dotcom %}**.
![Screenshot of the sign in button](/assets/images/help/codespaces/jetbrains-gateway-sign-in.png)
@@ -112,8 +111,9 @@ The first time you use JetBrains Gateway for {% data variables.product.prodname_
![Screenshot of the one-time login code](/assets/images/help/codespaces/jetbrains-gateway-login-code.png)
1. If you are not currently signed in to {% data variables.product.prodname_dotcom %}, the sign-in page is displayed. Enter your details and click **Sign in**.
1. Verify your authentication, for example by entering a two-factor authentication code.
1. If you are not currently signed in to {% data variables.product.prodname_dotcom %}, the sign-in page is displayed.
* Enter your details and click **Sign in**.
* Verify your authentication, for example by entering a two-factor authentication code.
1. On the "Device activation" page, paste the copied code and click **Continue**.
1. If you belong to organizations, the "Single sign-on to your organizations" page is displayed. Click **Authorize** beside the organizations you want to authorize the JetBrains Gateway to access, then click **Continue**.
1. On the "Authorize {% data variables.product.prodname_github_codespaces %} for JetBrains" page, click **Authorize {% data variables.product.prodname_dotcom %}**.
@@ -122,7 +122,12 @@ The first time you use JetBrains Gateway for {% data variables.product.prodname_
## Opening a codespace in your JetBrains IDE
{% data reusables.codespaces.opening-codespace-in-jetbrains %}
The first time you connect to a codespace, the backend IDE will be downloaded to the remote machine. This may take a few minutes. The next time you connect to the same codespace this step won't be necessary, making the connection process quicker. The backend IDE is then started. Again, this step will not be required in future if you are reconnecting to a backend IDE that you have left running. The client application is then launched.
The first time you connect to a codespace, the backend IDE will be downloaded to the remote machine. This may take a few minutes. The next time you connect to the same codespace this step won't be necessary, making the connection process quicker.
The backend IDE is then started. Again, this step will not be required in future if you are reconnecting to a backend IDE that you have left running.
The client application is then launched.
## Further reading