Spécification de secrets recommandés pour un dépôt

À propos des secrets recommandés

Si un projet a besoin de configurer des secrets spécifiques à l’utilisateur, vous pouvez inviter les utilisateurs à le faire lorsqu’ils créent un codespace. Pour ce faire, ajoutez un paramètre à un fichier de configuration de conteneur de développement pour le dépôt.

Après avoir spécifié des secrets recommandés, si les utilisateurs n’ont pas encore créé ces secrets dans leurs paramètres personnels pour Codespaces, ils sont invités à le faire lorsqu’ils utilisent la méthode des options avancées pour créer un codespace. Pour ce faire, cliquez sur GitHub.com en cliquant sur le bouton Code, en cliquant sur l’onglet Codespaces, puis en sélectionnant et en cliquant sur Nouveau avec des options.

Les secrets recommandés sont listés en bas de la page.

Chaque secret recommandé s’affiche de l’une des trois manières suivantes :

• Si la personne n’a pas défini le secret recommandé dans ses paramètres Codespaces, une zone d’entrée s’affiche, ce qui lui permet de créer le secret maintenant. Une description et un lien vers plus d’informations s’affichent si vous les avez configurés. L’entrée d’une valeur est facultative.
• Si la personne a déjà créé le secret recommandé mais ne l’a pas associé à ce dépôt, elle peut cocher une case pour ajouter cette association. Cette opération est facultative.
• Si la personne a déjà créé le secret recommandé et l’a associé à ce dépôt, une case à cocher présélectionnée s’affiche.

Quand spécifier des secrets recommandés pour un projet

Vous devez utiliser les secrets recommandés pour les secrets d’environnement de développement que l’utilisateur qui crée le codespace, plutôt que le propriétaire du référentiel ou de l’organisation, doit fournir. Par exemple, si vous avez un projet public et que les utilisateurs doivent fournir une clé API personnelle pour exécuter l’application dans votre projet, vous pouvez spécifier un secret recommandé afin que les utilisateurs soient invités à fournir la clé comme valeur du secret lorsqu’ils utilisent la page des options avancées pour créer un codespace.

Sinon, vous pouvez définir les secrets d’environnement de développement que le propriétaire du référentiel ou de l’organisation peut fournir, tels que les clés API partagées au sein d’une équipe, au niveau du référentiel ou de l’organisation. Pour plus d’informations, consultez « Gestion des secrets d’environnement de développement pour votre référentiel ou votre organisation ».

Spécification des secrets recommandés dans la configuration de conteneur de développement

1. Vous pouvez configurer les codespaces créés pour votre dépôt en ajoutant des paramètres à un fichier devcontainer.json. Si votre dépôt ne contient pas encore de fichier devcontainer.json, vous pouvez en ajouter un maintenant. Consultez « Ajout d’une configuration de conteneur de développement à votre dépôt ».

2. Modifiez le fichier devcontainer.json en ajoutant la propriété secrets au niveau supérieur du fichier, dans l’objet JSON englobant. Par exemple :

   JSON

   "secrets": {
     "NAME_OF_SECRET_1": {
       "description": "This is the description of the secret.",
       "documentationUrl": "https://example.com/link/to/info"
     },
     "NAME_OF_SECRET_2": { }
   }
   

3. Ajoutez une propriété dans secrets pour chaque secret que vous souhaitez recommander. Par exemple, remplacez NAME_OF_SECRET_1 et NAME_OF_SECRET_2, dans l’exemple de code précédent, par les noms des secrets que les utilisateurs doivent créer dans leurs paramètres personnels pour Codespaces.

4. Si vous le souhaitez, fournissez une description pour chaque secret et une URL pour plus d’informations sur chacun d’eux.

   Vous pouvez omettre description et documentationUrl, comme indiqué dans NAME_OF_SECRET_2 dans l’exemple de code précédent.

5. Spécifiez des secrets supplémentaires, si besoin.

6. Enregistrez le fichier et commitez vos changements dans la branche nécessaire du dépôt.

Pour aller plus loin

• « Création d’un codespace pour un dépôt »