Skip to main content

Création d’un codespace pour un dépôt

Vous pouvez créer un espace de code pour une branche dans un dépôt à développer en ligne.

À propos de la création d’un codespace pour un dépôt

Vous pouvez créer un codespace sur GitHub.com, dans Visual Studio Code ou à l’aide de GitHub CLI. Utilisez les onglets de cet article afin d’afficher des instructions pour chacune de ces méthodes de création d’un codespace.

Vous pouvez utiliser GitHub Codespaces sur votre compte personnel GitHub.com, avec le quota d’utilisation gratuite inclus chaque mois pour les comptes associés aux plans Gratuit et Pro. Vous pouvez continuer à utiliser GitHub Codespaces au-delà de votre utilisation mensuelle de stockage et de calcul comprise, en fournissant des détails de paiement et en définissant une limite de dépense. Pour plus d’informations, consultez « À propos de la facturation pour GitHub Codespaces ».

Les organisations peuvent, à leurs frais, permettre aux membres et aux collaborateurs externes de créer et d’utiliser des codespaces. Pour plus d’informations, consultez « Choisir qui possède et achète les codespaces dans votre organisation ».

Votre capacité à créer des codespaces à partir de dépôts appartenant à l’organisation dépend de plusieurs facteurs, notamment la visibilité du dépôt et les paramètres de l’organisation ou de son entreprise parente. Pour plus d’informations, consultez « Résolution des problèmes de création et de suppression de codespaces ».

Si vous démarrez un nouveau projet, vous voudrez probablement créer un codespace à partir d’un modèle et le publier dans un dépôt sur GitHub ultérieurement. Pour plus d’informations, consultez « Création d’un codespace à partir d’un modèle ».

Remarque : Si vous utilisez un IDE JetBrains, vous pouvez utiliser GitHub CLI pour créer un codespace. Vous pouvez ensuite utiliser l’application JetBrains Gateway pour ouvrir le codespace dans un IDE JetBrains. Pour plus d’informations, consultez « Utilisation de GitHub Codespaces dans votre IDE JetBrains ».

Si vous créez un codespace à partir d’un dépôt, le codespace est associé à une branche spécifique, qui ne peut pas être vide. Vous pouvez créer plusieurs codespaces par référentiel, voire par branche.

Vous pouvez voir tous les codespaces disponibles que vous avez créés sur la page « Vos codespaces ». Pour afficher cette page, dans le coin supérieur gauche de GitHub.com, sélectionnez , puis cliquez sur Codespaces. Cela vous redirige vers github.com/codespaces.

Processus de création d’un codespace

Lorsque vous créez un codespace, un certain nombre d’étapes sont nécessaires pour créer votre environnement de développement et vous y connecter :

  • Étape 1 : la machine virtuelle et le stockage sont affectés à votre codespace.
  • Étape 2 : le conteneur est créé et votre dépôt est cloné.
  • Étape 3 : vous pouvez vous connecter au codespace.
  • Étape 4 : le codespace continue avec la configuration après création.

Pour plus d’informations sur ce qui se passe lorsque vous créez un codespace, consultez « Présentation approfondie de GitHub Codespaces ».

Pour plus d’informations sur le cycle de vie d’un codespace, consultez « Présentation du cycle de vie des codespaces ».

Si vous souhaitez utiliser des crochets Git pour votre codespace, vous devez configurer les crochets en utilisant les scripts de cycle de vie devcontainer.json, comme postCreateCommand. Ils sont exécutés à l’étape 4, ci-dessus. Pour plus d’informations sur les scripts de cycle de vie, consultez la spécification des conteneurs de développement sur le site web Conteneurs de développement. Étant donné que votre conteneur de développement est créé une fois le dépôt cloné, aucun répertoire de modèles Git configuré dans l’image conteneur de développement ne s’applique pas à votre codespace. Les crochets doivent plutôt être installés après la création du codespace.

Vous pouvez modifier du code, faire du débogage et utiliser des commandes Git tout en développant dans un codespace avec VS Code. Pour plus d’informations, consultez la documentation de VS Code.

Pour accélérer la création des codespaces, les administrateurs de dépôt peuvent activer les prébuilds de GitHub Codespaces pour un dépôt. Pour plus d’informations, consultez « À propos des prébuilds GitHub Codespaces ».

Création d’un codespace pour un dépôt

  1. Dans GitHub.com, accédez à la page principale du dépôt.

  2. Sous le nom du dépôt, sélectionnez le menu déroulant de la branche, qui porte le nom de la branche active, puis cliquez sur la branche pour laquelle vous souhaitez créer un codespace.

    Capture d’écran du menu déroulant de la branche développée, avec la liste des différentes branches. Le menu déroulant, avec une icône de branche et le texte « trunk », est mis en évidence avec un encadré orange foncé.

  3. Cliquez sur le bouton Code, puis sur l’onglet Codespaces.

    Un message s’affiche en bas de la boîte de dialogue pour vous indiquer qui paiera pour le codespace.

    Capture d’écran de la boîte de dialogue Codespaces. Le message indiquant qui paiera pour le codespace est mis en évidence avec un contour orange foncé.

  4. Créez votre codespace en utilisant les options par défaut, ou après configuration d’options avancées :

    • Utiliser les options par défaut

      Pour créer un codespace en utilisant les options par défaut, cliquez sur .

    • Configurer les options avancées

      Pour configurer des options avancées pour votre codespace, telles qu’un autre type de machine ou un fichier devcontainer.json particulier :

      1. En haut à droite de l’onglet Codespaces, sélectionnez et cliquez sur Nouveau avec des options.

        Capture d’écran de la liste déroulante des options sous l’onglet « Codespaces », avec l’option « Nouveau avec des options » mise en évidence.

      2. Dans la page d’options pour votre codespace, choisissez vos options préférées dans les menus déroulants.

        Capture d’écran de la page des options avancées avec les boutons « Branche », « Configuration du conteneur de développement », « Région » et « Type de machine ».

        La page d’options peut également afficher les noms d’un ou plusieurs secrets qu’il vous est recommandé de créer dans vos paramètres Codespaces. Pour plus d’informations, consultez « Secrets recommandés ».

        Remarques

      3. Cliquez sur Créer codespace.

Les noms des secrets définis par l’utilisateur peuvent s’afficher dans la page des options avancées lorsque vous créez un codespace. Cela se produit si des secrets recommandés ont été spécifiés dans la configuration de conteneur de développement que vous avez sélectionnée. Pour plus d’informations, consultez « Spécification de secrets recommandés pour un dépôt ».

Screenshot of the "Create codespace" page with four recommended secrets highlighted with a dark orange outline.

L’entrée de valeurs pour ces secrets d’environnement de développement, lorsque vous êtes invité à le faire, est recommandée, car il est probable que votre projet aura besoin de valeurs pour ces secrets. Toutefois, il n’est pas nécessaire de fournir des valeurs pour créer un codespace. Vous pouvez définir ces secrets dans le codespace si vous préférez.

Si vous entrez une valeur pour un secret recommandé, le secret sera disponible dans le nouveau codespace. Lorsque vous cliquez sur Créer un codespace, le secret est également ajouté à vos paramètres personnels pour Codespaces. Vous n’aurez donc plus besoin d’entrer une valeur pour le secret lorsque vous créerez un codespace pour ce dépôt.

Si le nom d’un secret est affiché avec une case à cocher que vous ne pouvez pas sélectionner et aucune zone d’entrée, c’est parce que vous avez déjà un secret de ce nom configuré dans vos paramètres personnels pour Codespaces et que vous l’avez associé à ce dépôt. Si vous avez créé un secret de ce nom, mais que vous ne l’avez pas associé à ce dépôt, la case à cocher peut être sélectionnée et, ce faisant, vous pouvez mettre à jour vos paramètres pour ajouter l’association.

Si vous souhaitez changer la valeur d’un secret présélectionné, vous pouvez le faire à partir de vos paramètres personnels pour Codespaces sur github.com/settings/codespaces. Pour plus d’informations, consultez « Gestion des secrets spécifiques à votre compte pour GitHub Codespaces ».

Après avoir connecté votre compte sur GitHub.com à l’extension GitHub Codespaces, vous pouvez créer un codespace. Pour plus d’informations sur l’extension GitHub Codespaces, consultez la VS Code Marketplace.

  1. Dans VS Code, dans la barre Activité, cliquez sur l’icône de l’Explorateur distant.

    Capture d’écran de la barre d’activités. L’icône de la barre latérale « Explorateur distant » (rectangle avec un cercle par-dessus) est mise en évidence avec un encadré orange.

    Remarque : Si l’Explorateur distant n’est pas affiché dans la barre d’activité :

    1. Accédez à la palette de commandes. Par exemple, en appuyant sur Maj+Commande+P (Mac)/Ctrl+Maj+P (Windows/Linux).
    2. Entrez : details.
    3. Cliquez sur Codespaces : Détails.
  2. Pointez sur la barre latérale « Explorateur distant », puis cliquez sur .

    Capture d’écran de la barre latérale « Explorateur distant » pour GitHub Codespaces. L’info-bulle « Créer un codespace » s’affiche à côté du bouton signe plus.

  3. Dans la zone de texte, entrez le nom du référentiel dans lequel vous souhaitez développer, puis sélectionnez-le.

    Capture d’écran de « octo-org/he » entré dans la zone de texte et une liste de quatre dépôts qui commencent par cette chaîne.

    Un message s’affiche à droite des invites suivantes vous indiquant qui paiera pour le codespace.

    Capture d’écran d’une invite pour une branche, avec le message « Utilisation payée par hubwriter ».

  4. Cliquez sur la branche sur laquelle vous souhaitez développer.

  5. Si vous êtes invité à choisir un fichier de configuration de conteneur de développement, choisissez un fichier dans la liste.

  6. Choisissez le type de machine que vous souhaitez utiliser.

    Remarque : Votre choix de types d’ordinateurs disponibles peut être limité par un certain nombre de facteurs. Il peut s’agir par exemple d’une stratégie configurée pour votre organisation, ou une spécification de type d’ordinateur minimal pour votre dépôt. Pour plus d’informations, consultez « Restriction de l’accès aux types de machines » et « Définition d’une spécification minimale pour les machines de codespaces ».

Pour plus d’informations sur GitHub CLI, consultez « À propos de GitHub CLI ».

Pour créer un codespace, utilisez la sous-commande gh codespace create.

gh codespace create

Vous êtes invité à choisir un dépôt. Un message s’affiche vous indiquant qui doit payer pour le codespace. Vous êtes invité à choisir une branche, un fichier de configuration de conteneur de développement (si plusieurs sont disponibles) et un type de machine (si plusieurs sont disponibles).

Vous pouvez également utiliser des indicateurs pour spécifier tout ou partie des options :

gh codespace create -r OWNER/REPO -b BRANCH --devcontainer-path PATH -m MACHINE-TYPE

Dans cet exemple, remplacez owner/repo par l’identificateur du dépôt. Remplacez branch par le nom de la branche, ou le hachage SHA complet de la validation, dont vous souhaitez l’extraction initiale dans le codespace. Si vous utilisez l’indicateur -r sans l’indicateur b, le codespace est créé à partir de la branche par défaut.

Remplacez path par le chemin du fichier de configuration de conteneur de développement que vous souhaitez utiliser pour le nouveau codespace. Si vous omettez cet indicateur et que plusieurs fichiers de conteneur de développement sont disponibles, vous êtes invité à en choisir un dans une liste. Pour plus d’informations sur le fichier de configuration de conteneur de développement, consultez « Présentation des conteneurs de développement ».

Remplacez machine-type par un identificateur valide pour un type de machine disponible. Les identificateurs sont des chaînes telles que : basicLinux32gb et standardLinux32gb. Les types de machines disponibles dépendent du dépôt, de votre compte personnel et de votre emplacement. Si vous entrez un type de machine non valide ou indisponible, les types disponibles sont affichés dans le message d’erreur. Si vous omettez cet indicateur et que plusieurs types de machines sont disponibles, vous êtes invité à en choisir un dans une liste.

Pour obtenir des détails complets sur les options de cette commande, consultez le manuel de GitHub CLI.

Pour aller plus loin