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.

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 Enterprise Cloud 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 Codespaces dans votre IDE JetBrains ».

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 de 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 « Activation de GitHub Codespaces pour votre organisation ».

Les codespaces que vous créez ne sont accessibles qu’à vous. Personne d’autre ne peut travailler dans votre codespace.

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 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 ».

Pour plus d’informations sur le cycle de vie d’un codespace, consultez « Cycle de vie des codespaces ».

Si vous souhaitez utiliser des crochets Git pour votre codespace, vous devriez configurer des crochets à l’aide de scripts de cycle de vie devcontainer.json, tels que postCreateCommand, à l’étape 4. Étant donné que votre conteneur de codespace est créé une fois le dépôt cloné, aucun répertoire de modèles Git configuré dans l’image conteneur ne s’applique pas à votre codespace. Les crochets doivent plutôt être installés après la création du codespace. Pour plus d’informations sur l’utilisation de postCreateCommand, consultez la référence devcontainer.json dans la documentation de VS Code.

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 de 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, utilisez le menu déroulant « Branche », puis sélectionnez la branche pour laquelle vous souhaitez créer un codespace.

    Menu déroulant Branche

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

    Bouton Nouveau codespace

    Si les codespaces de ce dépôt sont facturables à une organisation ou à son entreprise parente, un message s’affiche sous le bouton Créer un codespace sur BRANCH vous indiquant qui doit payer pour le codespace.

  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 le signe plus (). Sinon, si vous n’avez aucun codespace pour ce dépôt, vous pouvez cliquer sur Créer un codespace sur BRANCH.

    • Configurer les options

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

      1. Cliquez sur les points de suspension ( ... ) en haut à droite de l’onglet Codespaces et sélectionnez Nouveau avec des options.

        Afficher le type de machine par défaut

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

        Page d’options de codespace

        Remarques

      3. Cliquez sur Créer codespace.

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 latérale gauche, cliquez sur l’icône de l’Explorateur distant.

    Icône de l’Explorateur distant dans Visual Studio Code

    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 : codespaces.
    3. Cliquez sur Codespaces : Détails.
  2. Cliquez sur l’icône Ajouter : .

    Option Créer un codespace dans GitHub Codespaces

  3. Entrez le nom du référentiel dans lequel vous souhaitez développer, puis sélectionnez-le.

    Recherche de dépôt pour créer un codespace

    Si le dépôt que vous choisissez appartient à une organisation et que l’organisation a configuré des codespaces pour que ce dépôt soit facturable à l’organisation, ou à son entreprise parente, un message s’affiche dans les invites successives vous indiquant qui paie le codespace.

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

    Recherche d’une branche pour créer un codespace

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

    Choix d’un fichier de configuration de conteneur de développement pour GitHub Codespaces

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

    Types d’instance pour un nouveau codespace

    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 machine » et « Définition d’une spécification minimale pour les machines de codespaces ».

Pour en savoir plus 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. Si les codespaces de ce dépôt sont facturables à une organisation ou à son entreprise parente, 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