Gestion des secrets spécifiques à votre compte pour GitHub Codespaces

Vous pouvez stocker les informations sensibles (telles que des jetons) auxquelles vous souhaitez accéder dans vos codespaces via des variables d’environnement.

Dans cet article

À propos des secrets pour GitHub Codespaces

Vous pouvez ajouter des secrets d’environnement de développement à votre compte personnel pour les utiliser dans vos codespaces. Par exemple, vous pouvez souhaiter stocker et accéder aux informations sensibles suivantes sous forme de secrets :

Vous pouvez déterminer quels dépôts doivent avoir accès à chaque secret. Ensuite, vous pouvez utiliser chaque secret dans un codespace que vous créez pour un dépôt qui a accès à ces secrets. Pour partager un secret avec un codespace créé à partir d’un modèle, vous devez publier le codespace dans un dépôt sur GitHub, puis accorder à ce dépôt l’accès au secret.

Une fois que vous avez créé un secret, il est disponible quand vous créez un codespace ou redémarrez ce codespace. Si vous avez créé un secret sur GitHub et que vous souhaitez l’utiliser dans un codespace en cours d’exécution, arrêtez le codespace, puis redémarrez-le. Pour plus d’informations sur l’arrêt du codespace, consultez « Utilisation de la palette de commandes de code Visual Studio dans GitHub Codespaces ».

Nommage des secrets

Les règles suivantes s’appliquent aux noms de secrets :

  • Les noms de secrets peuvent contenir uniquement des caractères alphanumériques ([a-z], [A-Z], [0-9]) ou des traits de soulignement (_). Les espaces ne sont pas autorisés.
  • Les noms de secrets ne doivent pas commencer par le préfixe GITHUB_.
  • Les noms de secrets ne doivent pas commencer par un chiffre.
  • Les noms de secrets ne respectent pas la casse.
  • Les noms de secrets doivent être uniques au niveau auquel ils sont créés. Par exemple, un secret créé au niveau du dépôt doit avoir un nom unique dans ce dépôt.

S’il existe un secret du même nom à plusieurs niveaux, le secret au niveau le plus bas est prioritaire. Par exemple, si un secret au niveau de l’organisation porte le même nom qu’un secret au niveau du dépôt, celui-ci est prioritaire.

Limites pour les secrets

Vous pouvez stocker jusqu’à 100 secrets pour GitHub Codespaces.

La taille des secrets est limitée à 48 Ko.

Ajout d’un secret

  1. Dans le coin supérieur droit de n’importe quelle page sur GitHub, cliquez sur votre photo de profil, puis sur Paramètres .

  2. Dans la section « Planification du code et automatisation » de la barre latérale, cliquez sur Codespaces.

  3. À droite de « Secrets Codespaces », cliquez sur Nouveau secret.

  4. Sous « Nom », tapez un nom pour votre secret.

  5. Sous « Valeur », tapez la valeur de votre secret.

  6. Sélectionnez le menu déroulant « Accès référentiel », puis cliquez sur un référentiel auquel vous souhaitez donner accès au secret. Répétez l’opération pour chaque référentiel auquel vous souhaitez donner accès au secret.

    Capture d’écran du menu déroulant « Accès au dépôt ». Deux dépots sont listés dans le menu déroulant.

  7. Cliquez sur Ajouter un secret.

Modification d’un secret

Vous pouvez mettre à jour la valeur d’un secret existant et modifier les dépôts qui peuvent y accéder.

  1. Dans le coin supérieur droit de n’importe quelle page sur GitHub, cliquez sur votre photo de profil, puis sur Paramètres .

  2. Dans la section « Planification du code et automatisation » de la barre latérale, cliquez sur Codespaces.

  3. Sous « Secrets des codespaces », à droite du secret à modifier, cliquez sur Mettre à jour.

  4. Sous « Valeur », cliquez sur le lien « Entrer une nouvelle valeur ».

    Capture d’écran de la page « Codespaces / Mettre à jour le secret ». Le lien « Entrer une nouvelle valeur » est mis en évidence avec un encadré orange foncé.

  5. Sous « Valeur », tapez la valeur de votre secret.

  6. Sélectionnez le menu déroulant « Accès référentiel », puis cliquez sur un référentiel auquel vous souhaitez donner accès au secret. Répétez l’opération pour chaque référentiel auquel vous souhaitez donner accès au secret.

    Capture d’écran du menu déroulant « Accès au dépôt ». Deux dépots sont listés dans le menu déroulant.

  7. Si nécessaire, pour supprimer l’accès du secret à un dépôt, désélectionnez le dépôt.

    Capture d’écran montrant une liste de deux dépôts. Chacun a une case à cocher sélectionnée.

  8. Cliquez sur Save changes.

Suppression d’un secret

  1. Dans le coin supérieur droit de n’importe quelle page sur GitHub, cliquez sur votre photo de profil, puis sur Paramètres .
  2. Dans la section « Planification du code et automatisation » de la barre latérale, cliquez sur Codespaces.
  3. Sous « Secrets Codespaces », à droite du secret à supprimer, cliquez sur Supprimer.
  4. Lisez l’avertissement, puis cliquez sur OK.

Utilisation de secrets

Un secret d’environnement de développement est exporté en tant que variable d’environnement dans la session du terminal de l’utilisateur.

Capture d’écran du terminal dans VS Code. La commande « echo $EXAMPLE_API_KEY » retourne « aBCdeFG1234567 ».

Vous pouvez utiliser des secrets d’environnement de développement une fois le codespace généré et en cours d’exécution. Par exemple, un secret peut être utilisé :

  • Lors du lancement d’une application à partir du terminal intégré ou de la session ssh.
  • Dans un script de cycle de vie de conteneur de développement exécuté après l’exécution du codespace. Pour plus d’informations sur les scripts de cycle de vie de conteneur de développement, consultez la documentation sur le site web Development Containers : Specification.

Les secrets d’environnement de développement ne peuvent pas être utilisés :

  • Pendant la génération d’un codespace (autrement dit, dans un Dockerfile ou un point d’entrée personnalisé).
  • Dans une fonctionnalité de conteneur de développement. Pour plus d’informations, consultez la propriété features dans la spécification des conteneurs de développement sur le site web Conteneurs de développement.

Pour aller plus loin