Uso de GitHub Codespaces en el IDE de JetBrains

Acerca del Codespaces en IDE de JetBrains

Si usas un IDE de JetBrains para trabajar en el código, puedes aprovechar las ventajas de trabajar en un codespace. Para ello, usa la aplicación de puerta de enlace de JetBrains.

Después de instalar la puerta de enlace de JetBrains, puedes establecer JetBrains como editor predeterminado para Codespaces. Si lo hace, siempre que abra un codespace desde GitHub se iniciará la puerta de enlace de JetBrains para permitirle elegir el IDE de JetBrains y conectarle al codespace.

Al trabajar en un codespace, se usa la aplicación cliente ligero de JetBrains en el equipo local. Esto proporciona la interfaz gráfica para el IDE completo de JetBrains que prefieras, que se ejecuta en la máquina virtual remota que hospeda el codespace. El cliente ligero siempre se usa, incluso si el IDE de JetBrains completo está instalado localmente. El cliente ligero importa y usa cualquier configuración local del IDE de JetBrains.

Proceso de conexión de desarrollo remoto de JetBrains

El proceso básico que hay detrás del uso de un codespace en el IDE de JetBrains es el siguiente.

1. En la aplicación de puerta de enlace de JetBrains, selecciona uno de los codespaces activos o detenidos.
2. Después, elige el IDE de JetBrains que quieras usar.
3. Luego, el IDE de JetBrains seleccionado se descarga en la máquina virtual remota que hospeda el codespace y el código fuente.
4. La aplicación cliente ligera de JetBrains se descarga en el equipo local y se inicia.
5. La aplicación cliente se conecta al IDE de back-end completo.
6. Puedes trabajar en el código de la aplicación cliente de la misma manera que lo harías en un entorno local.

Requisitos previos

Para trabajar en un codespace en un IDE de JetBrains, necesitas lo siguiente:

• Una licencia válida de JetBrains
• La aplicación JetBrains Gateway, versiones 2023.3.* o 2024.1.*.
• Un espacio de código existente que se ejecuta en una máquina virtual que tiene al menos 4 núcleos. El codespace también debe ejecutar un servidor SSH. Para obtener más información, consulta Codespace que ejecuta un servidor SSH.

Licencia de JetBrains

Debe tener una licencia de JetBrains que admita el IDE que elija en la puerta de enlace de JetBrains.

Puerta de enlace de JetBrains

Puedes instalar y actualizar la puerta de enlace de JetBrains desde la aplicación de Cuadro de herramientas de JetBrains.

1. Descarga e instala el Cuadro de herramientas de JetBrains.

2. Abre el Cuadro de herramientas de JetBrains.

3. Busque Puerta de enlace en la lista de herramientas disponibles.

   

4. A la derecha de Puerta de enlace, haga clic en los puntos suspensivos (...) y, a continuación, haga clic en Versiones disponibles.

5. En la lista de versiones, junto a una versión compatible (consulta Requisitos previos), haz clic en Instalar.

Codespace que ejecuta un servidor SSH

Debes tener un codespace al que conectarse y la máquina virtual que hospeda el codespace debe tener al menos 4 núcleos. Puede crear un codespace en GitHub, en Visual Studio Code o utilizando el GitHub CLI. Para obtener más información, consulta Creación de un codespace para un repositorio.

El codespace al que te conectes debe ejecutar un servidor SSH. La imagen de contenedor de dev predeterminada incluye un servidor SSH, que se inicia automáticamente. Si los codespaces no se crean a partir de la imagen predeterminada, puedes instalar e iniciar un servidor SSH agregando lo siguiente al objeto features en el archivo devcontainer.json.

"features": {
    // ...
    "ghcr.io/devcontainers/features/sshd:1": {
        "version": "latest"
    },
    // ...
}

Para obtener más información sobre el archivo devcontainer.json y la imagen de contenedor predeterminada, consulta Introducción a los contenedores dev.

Configuración de la Puerta de enlace de JetBrains

La primera vez que uses la Puerta de enlace de JetBrains para GitHub Codespaces, debes instalar el complemento de Codespaces. También debe permitir que la Puerta de enlace de JetBrains acceda a GitHub mediante la cuenta de GitHub.

1. Abra la aplicación Cuadro de herramientas de JetBrains.

2. En la lista de herramientas instaladas, haga clic en Puerta de enlace.

3. En Instalar más proveedores, haz clic en el vínculo Instalar para GitHub Codespaces.

   

4. Haz clic en Conectar a codespace.

   

5. La primera vez que te conectas se te solicita que elijas si quieres permitir que GitHub recopile datos de uso anónimos para mejorar la funcionalidad y la experiencia del usuario. Haz clic en Permitir o Denegar.

   Si fuera necesario, pueden cambiar la opción elegida más adelante, en la configuración del complemento de GitHub Codespaces, al que puede acceder desde la configuración de JetBrains Gateway.

6. En el cuadro de diálogo "Bienvenido a la Puerta de enlace de JetBrains", haz clic en Iniciar sesión con GitHub .

7. Haz clic en el icono que aparece junto al código de un solo uso para copiarlo.

   

8. Haz clic en el vínculo de inicio de sesión, debajo del código de inicio de sesión.

9. Si no has iniciado sesión actualmente en GitHub, se muestra la página de inicio de sesión.

   • Escribe la información y haz clic en Iniciar sesión.
   • Comprueba la autenticación, por ejemplo, escribiendo un código de autenticación en dos fases.

10. En la página "Activación del dispositivo", pega el código copiado y haz clic en Continuar.

11. Si perteneces a organizaciones, se muestra la página "Inicio de sesión único en tus organizaciones". Haz clic en Autorizar junto a las organizaciones a las que quieres autorizar el acceso a la Puerta de enlace de JetBrains y, después, haz clic en Continuar.

12. En la página "Autorizar GitHub Codespaces para JetBrains", haz clic en Autorizar GitHub .

13. Vuelve a la aplicación de Puerta de enlace de JetBrains y abre un codespace de la lista de codespaces activos o detenidos actualmente; consulta el paso 3 del procedimiento siguiente.

Apertura de un codespace en el IDE de JetBrains

Si ha establecido la puerta de enlace de JetBrains como editor predeterminado, la puerta de enlace se iniciará automáticamente al abrir un espacio de código desde GitHub.

Si la puerta de enlace de JetBrains no es el editor predeterminado, todavía puedes abrir un codespace en JetBrains; para ello, ve a la página "Sus codespaces" en github.com/codespaces y haz clic en los puntos suspensivos (...) a la derecha del espacio de código que quieres abrir. Para obtener más información, vea «Apertura de un codespace existente».

Como alternativa, también puedes abrir la puerta de enlace de JetBrains y seleccionar un espacio de código existente, como se describe en el procedimiento siguiente.

1. Abre la aplicación de Puerta de enlace de JetBrains.

2. Haz clic en Conectar con Codespaces .

   

3. En la lista "Your Codespaces", haz clic en el codespace en el que quieres trabajar.

   

4. En la lista "IDE disponibles", haz clic en el IDE de JetBrains que quieres usar. La puerta de enlace recordará tu elección la próxima vez que te conectes a un codespace.

   

5. Haga clic en Conectar.

   Note

   • Si eligió Rider como IDE de JetBrains y el repositorio contiene varios archivos de solución, se muestra el cuadro de diálogo "Establecer ruta de solución" en el que se le pide que elija la solución en la que desea trabajar. Elija un archivo de solución en el menú desplegable y haga clic en Aceptar.

     Si el repositorio no tiene un archivo de solución, Rider se abre en una vista de directorio de proyecto básica y tendrá funcionalidades limitadas. Por ejemplo, no obtendrá . Navegación de código específica de NET. Si solo hay un único archivo de solución en el repositorio, se usará automáticamente, sin que se muestre el mensaje. Para obtener más información, consulte "Crear y abrir proyectos y soluciones" en la documentación de JetBrains.
     
     

   • Si ejecuta un firewall, es posible que la primera vez que te conectas a un recurso remoto se te pida que permitas que la puerta de enlace de JetBrains se comunique a través de la red.

   La primera vez que te conectes a un codespace, el IDE de back-end se descargará en la máquina remota. Esta operación puede tardar unos minutos. La próxima vez que te conectes al mismo codespace, este paso no será necesario, lo que hace que el proceso de conexión sea más rápido.

   Después, se inicia el IDE de back-end. De nuevo, este paso no será necesario en el futuro si vuelves a conectarte a un IDE de back-end que hayas dejado en ejecución.

   Luego, se inicia la aplicación cliente.

Información adicional

• Desarrollar en un codespace
• Uso del complemento de GitHub Codespaces para JetBrains
• Solución de problemas de clientes de GitHub Codespaces