Skip to main content

Utilisation de GitHub Codespaces dans votre IDE JetBrains

Vous pouvez utiliser JetBrains Gateway pour vous connecter à votre codespace et travailler dans votre IDE JetBrains favori.

Remarques :

  • L'utilisation de GitHub Codespaces avec les IDE JetBrains est actuellement en version bêta publique, et peut faire l'objet de modifications.
  • Pour travailler sur un espace codespace dans un IDE JetBrains, vous devez utiliser la version 2023.3.* ou 2024.1.* de la passerelle Gateway JetBrains.

À propos de Codespaces dans les IDE JetBrains

Si vous utilisez un IDE JetBrains pour travailler sur votre code, vous pouvez tirer parti de l’utilisation d’un codespace. Pour ce faire, utilisez l’application JetBrains Gateway.

Après avoir installé la passerelle JetBrains, vous pouvez définir JetBrains comme éditeur par défaut pour Codespaces. Si tel est votre choix, chaque fois que vous ouvrez un codespace à partir de GitHub, la passerelle JetBrains se lance pour vous permettre de choisir votre IDE JetBrains et de vous connecter au codespace.

Lorsque vous travaillez dans un codespace, vous utilisez l’application cliente légère JetBrains sur votre ordinateur local. Cela fournit l’interface graphique de l’IDE JetBrains complet de votre choix, qui s’exécute sur la machine virtuelle distante qui héberge votre codespace. Le client léger est toujours utilisé, même si l’IDE JetBrains complet est installé localement. Tous les paramètres IDE JetBrains locaux sont importés et utilisés par le client léger.

Remarque : Seuls les codespaces existants sont disponibles dans JetBrains Gateway. Vous pouvez créer des codespaces dans GitHub ou à l’aide de GitHub CLI. Pour plus d’informations, consultez « Création d’un codespace pour un dépôt ».

Processus de connexion de développement à distance JetBrains

Le processus de base qui sous-tend l’utilisation d’un codespace dans votre IDE JetBrains est le suivant.

  • Dans l’application JetBrains Gateway, vous sélectionnez l’un de vos codespaces actifs ou arrêtés.
  • Vous choisissez ensuite l’IDE JetBrains que vous souhaitez utiliser.
  • L’IDE JetBrains sélectionné est ensuite téléchargé sur la machine virtuelle distante qui héberge votre codespace et votre code source.
  • L’application cliente légère JetBrains est ensuite téléchargée sur votre ordinateur local et démarrée.
  • L’application cliente se connecte à l’IDE back-end complet.
  • Vous pouvez travailler sur votre code dans l’application cliente de la même façon que dans un environnement local.

Prérequis

Pour travailler dans un codespace dans un IDE JetBrains, vous avez besoin des éléments suivants :

  • Une licence JetBrains valide.
  • L'application de la passerelle JetBrains Gateway, versions 2023 3.* ou 2024.1.*.
  • Un espace codespace existant s'exécutant sur une machine virtuelle dotée d'au moins quatre cœurs. L'espace codespace doit également exécuter un serveur SSH. Pour plus d'informations, consultez « Codespace exécutant un serveur SSH ».

Licence JetBrains

Vous devez avoir une licence JetBrains qui prend en charge l’IDE que vous choisissez dans la passerelle JetBrains.

JetBrains Gateway

Vous pouvez installer et mettre à jour JetBrains Gateway à partir de l’application JetBrains Toolbox.

  1. Téléchargez et installez JetBrains Toolbox.

  2. Ouvrez JetBrains Toolbox.

  3. Trouvez la passerelle Gateway dans la liste des outils disponibles.

    Capture d’écran de JetBrains Toolbox avec « Gateway » en bas de la liste des applications. Chaque application a un bouton « Installer » à côté.

  4. À droite de passerelle Gateway, cliquez sur les points de suspension (...), puis cliquez sur Versions disponibles.

  5. Dans la liste des versions, en regard d'une version prise en charge (consultez les « Prérequis »), cliquez sur Installer.

Codespace exécutant un serveur SSH

Vous devez disposer d’un codespace existant pour vous connecter, et la machine virtuelle qui héberge le codespace doit avoir au moins 4 cœurs. Vous pouvez créer un codespace sur GitHub, dans Visual Studio Code ou à l’aide de GitHub CLI. Pour plus d’informations, consultez « Création d’un codespace pour un dépôt ».

Le codespace auquel vous vous connectez doit exécuter un serveur SSH. L’image conteneur de développeur par défaut comprend un serveur SSH, qui est démarré automatiquement. Si vos codespaces ne sont pas créés à partir de l’image par défaut, vous pouvez installer et démarrer un serveur SSH en ajoutant ce qui suit à l’objet features dans votre fichier devcontainer.json.

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

Pour plus d’informations sur le fichier devcontainer.json et l’image conteneur par défaut, consultez « Présentation des conteneurs de développement ».

Remarque : Pour obtenir de l’aide sur la connexion à votre codespace via SSH, consultez « Résolution des problèmes liés aux clients GitHub Codespaces ».

Configuration de JetBrains Gateway

La première fois que vous utilisez JetBrains Gateway pour GitHub Codespaces, vous devez installer le plug-in Codespaces. Vous devez également autoriser JetBrains Gateway à accéder à GitHub avec votre compte GitHub.

  1. Ouvrez l'application JetBrains Toolbox.

  2. Dans la liste des outils installés, cliquez sur la passerelle Gateway.

  3. Sous Install More Providers (Installer plus de fournisseurs), cliquez sur le lien Install pour GitHub Codespaces.

    Capture d’écran de la page « Bienvenue dans la passerelle JetBrains », avec « GitHub Codespaces » répertorié sous « Installer d’autres fournisseurs ».

  4. Cliquez sur Connect to Codespace (Se connecter à Codespace).

    Capture d’écran de la passerelle avec le bouton « Se connecter à Codespaces ».

  5. La première fois que vous vous connectez, vous êtes invité à choisir d’autoriser GitHub à collecter des données d’utilisation anonymes, afin d’améliorer les fonctionnalités et l’expérience utilisateur. Cliquez sur Autoriser ou Refuser.

    Vous pouvez modifier votre choix ultérieurement, si nécessaire, dans les paramètres du plug-in GitHub Codespaces, auquel vous pouvez accéder dans les paramètres de la passerelle JetBrains.

  6. Dans la boîte de dialogue « Welcome to JetBrains Gateway », cliquez sur Sign In with GitHub .

  7. Cliquez sur l’icône à côté du code à usage unique pour le copier.

    Capture d’écran d’un code de connexion à usage unique. L’icône de copie à côté du code est mis en surbrillance par un encadré orange foncé.

  8. Cliquez sur le lien de connexion, sous le code de connexion.

  9. Si vous n’êtes pas connecté à GitHub, la page de connexion s’affiche.

    • Entrez vos informations, puis cliquez sur Sign in (Se connecter).
    • Vérifiez votre authentification, par exemple en entrant un code d’authentification à deux facteurs.
  10. Dans la page « Device activation » (Activation de l’appareil), collez le code copié, puis cliquez sur Continue.

  11. Si vous appartenez à des organisations, la page « Single sign-on to your organizations » (Authentification unique auprès de vos organisations) s’affiche. Cliquez sur Authorize (Autoriser) en regard des organisations que vous souhaitez rendre accessibles à JetBrains Gateway, puis cliquez sur Continue.

  12. Dans la page « Authorize GitHub Codespaces for JetBrains » (Autoriser GitHub Codespaces pour JetBrains), cliquez sur Authorize GitHub (Autoriser GitHub).

  13. Revenez à l’application JetBrains Gateway et ouvrez un codespace à partir de la liste de vos codespaces actifs ou arrêtés. Consultez l’étape 3 de la procédure suivante.

Ouverture d’un codespace dans votre IDE JetBrains

Si vous avez défini JetBrains Gateway comme éditeur par défaut, celui-ci se lance automatiquement lorsque vous ouvrez un codespace à partir de GitHub.

Si JetBrains Gateway n’est pas votre éditeur par défaut, vous pouvez quand même ouvrir un codespace dans JetBrains en accédant à la page « Vos codespaces » sur github.com/codespaces et en cliquant sur les points de suspension (...) à droite du codespace que vous souhaitez ouvrir. Pour plus d’informations, consultez « Ouverture d’un codespace existant ».

Vous pouvez également ouvrir JetBrains Gateway et sélectionner un codespace existant, comme décrit dans la procédure suivante.

  1. Ouvrez l’application JetBrains Gateway.

  2. Cliquez sur Se connecter à Codespaces .

    Capture d’écran de la page d’accueil JetBrains Gateway, montrant le bouton « Se connecter à Codespaces ».

  3. Dans la liste « Vos codespaces », cliquez sur le codespace dans lequel vous souhaitez travailler.

    Capture d’écran de la liste « Vos codespaces » dans JetBrains Gateway.

  4. Dans la liste « IDE disponibles », cliquez sur l’IDE JetBrains que vous souhaitez utiliser. JetBrains Gateway se souviendra de votre choix la prochaine fois que vous vous connecterez à un codespace.

    Capture d’écran de la liste déroulante « Sélectionner un IDE » dans JetBrains Gateway. Le pointeur de la souris pointe vers « IntelliJ IDEA ».

  5. Cliquez sur Connecter.

    Remarques:

    • Si vous avez choisi Rider comme IDE JetBrains et que le dépôt contient plusieurs fichiers de solution, la boîte de dialogue « Définir le chemin de la solution » s’affiche et vous invite à choisir la solution dans laquelle vous souhaitez travailler. Choisissez un fichier de solution dans le menu déroulant et cliquez sur OK.

      Si le dépôt n’a pas de fichier de solution, Rider s’ouvre dans une vue de répertoire de projet de base et dispose de fonctionnalités limitées. Par exemple, vous n’aurez pas la navigation de code spécifique à .NET. S’il n’existe qu’un seul fichier de solution dans le dépôt, il sera utilisé automatiquement, sans que l’invite ne s’affiche. Pour plus d’informations, consultez « Create and open projects and solutions » dans la documentation JetBrains.

    • Si vous exécutez un pare-feu, la première fois que vous vous connectez à une ressource distante, vous pouvez être invité à autoriser JetBrains Gateway à communiquer sur votre réseau.

    La première fois que vous vous connectez à un codespace, l’IDE back-end est téléchargé sur l’ordinateur distant. Cela peut prendre quelques minutes. La prochaine fois que vous vous connecterez au même codespace, cette étape ne sera pas nécessaire, ce qui accélérera le processus de connexion.

    L’IDE back-end est ensuite démarré. Là encore, cette étape ne sera pas nécessaire à l’avenir si vous vous reconnectez à un IDE back-end que vous avez laissé s’exécuter.

    L’application cliente est ensuite lancée.

Pour aller plus loin