Skip to main content

Résolution des problèmes liés aux clients GitHub Codespaces

Cet article fournit des informations vous permettant de résoudre les problèmes susceptibles de se produire avec le client utilisé pour GitHub Codespaces.

Remarque : L’utilisation de GitHub Codespaces avec des IDE JetBrains est actuellement en version bêta publique et peut faire l’objet de modification.

Résolution des problèmes liés au client web Visual Studio Code

Si vous rencontrez des problèmes lors de l’utilisation de GitHub Codespaces dans un navigateur qui n’est pas basé sur Chromium, essayez de passer à un navigateur Chromium comme Google Chrome ou Microsoft Edge. Vous pouvez également consulter les problèmes connus liés à votre navigateur dans le dépôt microsoft/vscode en recherchant les problèmes étiquetés avec le nom du navigateur, comme firefox ou safari.

Si vous rencontrez des problèmes liés à l’utilisation de GitHub Codespaces dans un navigateur basé sur Chromium, vous pouvez vérifier si vous rencontrez un autre problème connu avec VS Code dans le dépôt microsoft/vscode.

Différences par rapport à l’utilisation locale de VS Code

Quand vous ouvrez un codespace dans votre navigateur, avec le client web VS Code, vous remarquerez certaines différences par rapport à un espace de travail local dans l’application de bureau VS Code. Par exemple, certaines combinaisons de touches sont différentes ou absentes et certaines extensions peuvent se comporter différemment. Pour en obtenir un résumé, consultez : « Limitations et adaptations connues » dans la documentation de VS Code.

Vous pouvez consulter les problèmes connus et consigner de nouveaux problèmes avec l’expérience VS Code dans le dépôt microsoft/vscode.

Visual Studio Code Insiders

Visual Studio Code Insiders constitue la version la plus fréquente de VS Code. Elle comporte toutes les fonctionnalités et les correctifs de bogues les plus récents, mais peut aussi parfois contenir de nouveaux problèmes à l’origine d’une rupture de build.

Si vous utilisez une build Insiders et remarquez une rupture de comportement, nous vous recommandons de passer à Visual Studio Code Stable et de réessayer.

Cliquez sur en bas à gauche de l’éditeur, puis sélectionnez Basculer vers la version stable... . Si le client web VS Code ne se charge pas ou si n’est pas disponible, vous pouvez forcer le basculement vers Visual Studio Code Stable en ajoutant ?vscodeChannel=stable à l’URL de votre codespace et en chargeant le codespace à cette URL.

Si le problème n’est pas résolu dans Visual Studio Code Stable, consultez les problèmes connus et, si nécessaire, consignez un nouveau problème avec l’expérience VS Code dans le dépôt microsoft/vscode.

Résolution des problèmes liés au Navigateur simple

Lorsque vous avez démarré une application web dans un codespace, vous pouvez afficher un aperçu de l’application en cours d’exécution dans le Navigateur simple incorporé dans VS Code. Dans certains projets, l’application s’ouvre automatiquement dans un onglet Navigateur simple de l’éditeur lorsqu’elle démarrage. Cela se produit si, dans le fichier de configuration devcontainer.json du codespace, la propriété onAutoForward du port sur lequel l’application s’exécute est définie sur openPreview.

"portsAttributes": {
  "3000": {
    "label": "Application",
    "onAutoForward": "openPreview"
  }
}

Si l’onglet Navigateur simple ne s’ouvre pas automatiquement, vous pouvez ouvrir le Navigateur simple manuellement pour afficher l’application.

  1. Dans VS Code, cliquez sur l’onglet Ports.

  2. Cliquez avec le bouton droit sur le port, puis cliquez sur Aperçu dans l’Éditeur.

    Capture d’écran du menu contextuel sous l’onglet Ports VS Code. L’entrée de menu « Aperçu dans l’éditeur » est mise en évidence avec un encadré orange foncé.

L’onglet Navigateur simple ne s’ouvre pas automatiquement

Si le fichier de configuration devcontainer.json spécifie "onAutoForward": "openPreview" pour un port, mais que le Navigateur simple ne s’ouvre pas automatiquement au démarrage d’une application, vérifiez que l’application a démarré sur le port spécifié dans la configuration. L’application peut démarrer sur un autre port si le port prévu est occupé.

Pour implémenter la configuration de port spécifiée dans devcontainer.json, GitHub Codespaces écrit la configuration dans le fichier settings.json de VS Code lors de la création d’un codespace. Vous pouvez vérifier que la configuration a été correctement écrite dans settings.json dans votre codespace.

  1. Dans le terminal de votre codespace, entrez la commande suivante.

    Bash
    cat ~/.vscode-remote/data/Machine/settings.json
    
  2. Vérifiez que le fichier settings.json contient des lignes semblables à ce qui suit.

     "remote.portsAttributes": {
         "3000": {
             "label": "Application",
             "onAutoForward": "openPreview"
         }
     }
    

Si le fichier settings.json ne contient pas ces paramètres, vérifiez si les fichiers dotfile sont activés et si une configuration dans vos fichiers dotfile remplace le fichier settings.json. Pour plus d’informations, consultez « Personalizing GitHub Codespaces for your account ».

L’application ne se charge pas

Parfois, vous pouvez constater que l’onglet Navigateur simple s’ouvre, mais affiche une icône de page d’erreur ou une page vierge au lieu de votre application en cours d’exécution. Cela peut se produire si l’application web que vous chargez inclut une stratégie de sécurité du contenu (CSP) qui limite les domaines dans lesquels les pages du site peuvent être incorporées. Pour plus d’informations, consultez Stratégie de sécurité du contenu (CSP) : frame-ancestors sur le site web MDN.

Vous pouvez peut-être changer localement la stratégie de sécurité frame-ancestors de votre application pour qu’elle s’affiche dans le Navigateur simple. Sinon, si une stratégie frame-ancestors est à l’origine du problème, vous devez être en mesure d’afficher l’application en l’ouvrant sous un onglet de navigateur standard plutôt que dans le Navigateur simple. Pour ce faire, cliquez sur l’onglet Ports dans VS Code, cliquez avec le bouton droit sur le port, puis cliquez sur Ouvrir dans le navigateur.

Résolution des problèmes liés à VS Code

Quand vous ouvrez un codespace dans l’application de bureau VS Code, vous remarquerez peut-être quelques différences par rapport à un espace de travail local. Toutefois, l’expérience doit être similaire.

Si vous rencontrez des problèmes, vous pouvez consulter les problèmes connus et consigner de nouveaux problèmes avec l’expérience VS Code dans le dépôt microsoft/vscode.

Visual Studio Code Insiders

Visual Studio Code Insiders constitue la version la plus fréquente de VS Code. Elle comporte toutes les fonctionnalités et les correctifs de bogues les plus récents, mais peut aussi parfois contenir de nouveaux problèmes à l’origine d’une rupture de build.

Si vous utilisez une build Insiders et remarquez une rupture de comportement, nous vous recommandons de passer à Visual Studio Code Stable et de réessayer.

Pour passer à Visual Studio Code Stable, fermez l’application Visual Studio Code Insiders, ouvrez l’application Visual Studio Code Stable, puis rouvrez votre codespace.

Si le problème n’est pas résolu dans Visual Studio Code Stable, consultez les problèmes connus et, si nécessaire, consignez un nouveau problème avec l’expérience VS Code dans le dépôt microsoft/vscode.

Résolution des problèmes liés au Navigateur simple

Lorsque vous avez démarré une application web dans un codespace, vous pouvez afficher un aperçu de l’application en cours d’exécution dans le Navigateur simple incorporé dans VS Code. Dans certains projets, l’application s’ouvre automatiquement dans un onglet Navigateur simple de l’éditeur lorsqu’elle démarrage. Cela se produit si, dans le fichier de configuration devcontainer.json du codespace, la propriété onAutoForward du port sur lequel l’application s’exécute est définie sur openPreview.

"portsAttributes": {
  "3000": {
    "label": "Application",
    "onAutoForward": "openPreview"
  }
}

Si l’onglet Navigateur simple ne s’ouvre pas automatiquement, vous pouvez ouvrir le Navigateur simple manuellement pour afficher l’application.

  1. Dans VS Code, cliquez sur l’onglet Ports.

  2. Cliquez avec le bouton droit sur le port, puis cliquez sur Aperçu dans l’Éditeur.

    Capture d’écran du menu contextuel sous l’onglet Ports VS Code. L’entrée de menu « Aperçu dans l’éditeur » est mise en évidence avec un encadré orange foncé.

L’onglet Navigateur simple ne s’ouvre pas automatiquement

Si le fichier de configuration devcontainer.json spécifie "onAutoForward": "openPreview" pour un port, mais que le Navigateur simple ne s’ouvre pas automatiquement au démarrage d’une application, vérifiez que l’application a démarré sur le port spécifié dans la configuration. L’application peut démarrer sur un autre port si le port prévu est occupé.

Pour implémenter la configuration de port spécifiée dans devcontainer.json, GitHub Codespaces écrit la configuration dans le fichier settings.json de VS Code lors de la création d’un codespace. Vous pouvez vérifier que la configuration a été correctement écrite dans settings.json dans votre codespace.

  1. Dans le terminal de votre codespace, entrez la commande suivante.

    Bash
    cat ~/.vscode-remote/data/Machine/settings.json
    
  2. Vérifiez que le fichier settings.json contient des lignes semblables à ce qui suit.

     "remote.portsAttributes": {
         "3000": {
             "label": "Application",
             "onAutoForward": "openPreview"
         }
     }
    

Si le fichier settings.json ne contient pas ces paramètres, vérifiez si les fichiers dotfile sont activés et si une configuration dans vos fichiers dotfile remplace le fichier settings.json. Pour plus d’informations, consultez « Personalizing GitHub Codespaces for your account ».

L’application ne se charge pas

Parfois, vous pouvez constater que l’onglet Navigateur simple s’ouvre, mais affiche une icône de page d’erreur ou une page vierge au lieu de votre application en cours d’exécution. Cela peut se produire si l’application web que vous chargez inclut une stratégie de sécurité du contenu (CSP) qui limite les domaines dans lesquels les pages du site peuvent être incorporées. Pour plus d’informations, consultez Stratégie de sécurité du contenu (CSP) : frame-ancestors sur le site web MDN.

Vous pouvez peut-être changer localement la stratégie de sécurité frame-ancestors de votre application pour qu’elle s’affiche dans le Navigateur simple. Sinon, si une stratégie frame-ancestors est à l’origine du problème, vous devez être en mesure d’afficher l’application en l’ouvrant sous un onglet de navigateur standard plutôt que dans le Navigateur simple. Pour ce faire, cliquez sur l’onglet Ports dans VS Code, cliquez avec le bouton droit sur le port, puis cliquez sur Ouvrir dans le navigateur.

Résolution des problèmes liés aux IDE JetBrains

Problèmes de performance

Un type de machine GitHub Codespaces avec au moins 4 cœurs est recommandé pour exécuter l’un des IDE JetBrains. Pour plus d’informations, consultez « Modification du type de machine pour votre espace de code ».

Si vous utilisez une machine avec 4 cœurs ou plus et que le niveau de performance dans JetBrains vous semble médiocre, vous devrez peut-être augmenter la taille maximale du tas Java.

La taille de tas recommandée varie en fonction du type d’ordinateur de votre codespace.

Type de machineTaille maximale du tas
4 cœurs, 16 Go de RAM2048 Mio
8 cœurs, 32 Go de RAM4096 Mio
16 cœurs, 64 Go de RAM8192 Mio
32 cœurs, 128 Go de RAM16 384 Mio

Si la taille du tas est inférieure à la valeur recommandée, un message s’affiche au démarrage de votre codespace, vous suggérant d’augmenter la taille du tas. Vous pouvez cliquer sur le lien dans le message pour augmenter automatiquement la taille du tas.

Capture d’écran du message recommandant d’augmenter la taille du tas.

En fonction de la taille de votre codebase et de la mémoire nécessaire pour exécuter votre application, vous devrez peut-être augmenter la taille du tas. Vous devez définir la taille du tas entre la taille indiquée dans le tableau ci-dessus et 60 % de la RAM de l’hôte distant. Si vous avez une application volumineuse, vous ne devez pas définir une taille de tas trop grande, afin de permettre à l’application de disposer d’une mémoire suffisante.

  1. À gauche de la barre de navigation, en haut de la fenêtre d’application, cliquez sur le nom du codespace.

    Capture d’écran du client JetBrains. Le nom de codespace « urban meme », intitulé « Critique pour les ressources », est mis en évidence avec un encadré orange foncé.

  2. Sous l’onglet Performance, notez les détails de la charge du processeur et de la mémoire. Ces informations indiquent si la machine est surchargée.

    Capture d’écran de l’onglet « Performances » dans la liste déroulante des ressources, montrant la charge du processeur à 97,5 %, la mémoire à 60,6 % et le disque à 28,8 %.

  3. Cliquez sur l’onglet Paramètres et modifiez la taille du tas sans dépasser 60 % de la mémoire disponible pour votre codespace.

    Capture d’écran de l’onglet « Performances ». Dans le champ « Taille maximale de tas », 3072 est entré et encadré en orange foncé. En dessous se trouvent les boutons « Enregistrer » et « Enregistrer et redémarrer ».

  4. Cliquez sur Enregistrer et redémarrer.

Impossible d’ouvrir le client dans MacOS Ventura

Dans MacOS Ventura, lorsque vous essayez de vous connecter à un codespace à partir de la passerelle JetBrains pour la première fois alors que vous utilisez des version de JetBrains Gateway antérieures à la version 2022.3, un message vous indiquant que l’application cliente JetBrains « est endommagée et ne peut pas être ouverte » s’affichait.

Screenshot of the 'cannot be opened' error message

Ce problème est résolu dans JetBrains Gateway, version 2022.3 et ultérieure.

Pour contourner ce problème, mettez à jour JetBrains Gateway.

Pour contourner ce problème avec les versions antérieures de Gateway :

  1. Cliquez sur Annuler pour ignorer ce message.

  2. Cliquez sur l’icône Apple, en haut à gauche de l’écran, puis sur Paramètres système.

  3. Cliquez sur Confidentialité et sécurité et faites défiler jusqu’à la section « Sécurité ».

    Capture d’écran de la boîte de dialogue « Confidentialité et sécurité » MacOS, avec un message de sécurité au-dessus du client JetBrains et du bouton « Ouvrir quand même ».

    Vous voyez un message indiquant que l’utilisation du client JetBrains a été bloquée.

  4. Cliquez sur Ouvrir quand même pour ajouter le client JetBrains à vos applications reconnues. Le message s’affiche à nouveau, mais cette fois avec un bouton Ouvrir.

    Screenshot of the error message with an 'Open' button
  5. Cliquez à nouveau sur Annuler.

  6. Revenez à l’application JetBrains Gateway et connectez-vous à nouveau au codespace requis. Le client JetBrains s’ouvre maintenant avec succès. Après avoir autorisé l’application cliente à s’exécuter sur votre Mac, vous ne verrez plus le message lorsque vous vous connecterez à vos codespaces.

Problèmes de connexion SSH

Pour vous connecter par le biais du serveur SSH en cours d’exécution dans votre codespace, vous devez disposer dans votre répertoire ~/.ssh (MacOS et Linux) ou %HOMEPATH%\.ssh (Windows) d’une clé SSH qui a déjà été ajoutée à votre compte GitHub. Si aucune clé n’est présente dans ce répertoire, GitHub CLI génère des clés pour vous. Pour plus d’informations, consultez « Ajout d’une nouvelle clé SSH à votre compte GitHub ».

Si vous rencontrez des problèmes de validation des clés, essayez de mettre à niveau votre version de GitHub CLI. Pour plus d’informations, consultez les instructions de mise à niveau dans le fichier README de GitHub CLI.

Problèmes liés à l’IDE JetBrains

Pour obtenir de l’aide sur les problèmes spécifiques à l’IDE JetBrains que vous utilisez ou à l’application JetBrains Gateway, consultez « Support produit » sur le site web de JetBrains.