Inscription d’une application GitHub

À propos de l’inscription d’GitHub Apps

Vous pouvez inscrire une GitHub App appartenant à votre compte personnel, à une organisation dont vous êtes propriétaire ou à une organisation qui vous a accordé l’autorisation de gérer toutes les applications appartenant à l’organisation. Pour plus d’informations, consultez « Ajout et suppression de gestionnaires d’application GitHub dans votre organisation ».

Inscription d’une GitHub App

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

2. Accédez aux paramètres de votre compte.

   • Pour une application appartenant à un compte personnel, cliquez sur Paramètres.
   • Pour une application appartenant à une organisation :
     1. Cliquez sur Vos organisations.
     2. À droite de l’organisation, cliquez sur Paramètres.

3. Dans la barre latérale gauche, cliquez sur Paramètres de développeur.

4. Dans la barre latérale à gauche, cliquez sur GitHub Apps .

5. Cliquez sur Nouvelle application GitHub.

6. Sous « Nom de l’application GitHub », entrez un nom pour votre application. Vous devez choisir un nom clair et court. Le nom ne doit pas comporter plus de 34 caractères. Le nom de votre application (converti en minuscules, avec les espaces remplacés par - et les caractères spéciaux remplacés) s’affiche dans l’interface utilisateur lorsque votre application effectue une action. Par exemple, My APp Näme s’affiche sous la forme my-app-name.

   Le nom doit être unique dans GitHub. Vous ne pouvez pas utiliser le même nom qu’un compte GitHub existant, sauf s’il s’agit de votre propre nom d’utilisateur ou d’organisation.

7. Si vous le souhaitez, sous « Description », tapez une description de votre option. Les utilisateurs et les organisations verront cette description lorsqu’ils installeront votre application.

8. Sous « URL de la page d’accueil », tapez l’URL complète du site web de votre application. Si vous n’avez pas d’URL dédiée et que le code de votre application est stocké dans un dépôt public, vous pouvez utiliser cette URL de dépôt. Vous pouvez également utiliser l’URL de l’organisation ou de l’utilisateur propriétaire de l’application.

9. Si vous le voulez, sous « URL de rappel », entrez l’URL complète vers laquelle la redirection doit être effectuée, une fois qu’un utilisateur a autorisé l’installation.

   Vous pouvez entrer jusqu’à 10 URL de rappel. Pour ajouter des URL de rappel supplémentaires, cliquez sur Ajouter une URL de rappel.

   Si votre application n’a pas besoin d’agir au nom d’un utilisateur (n’a pas besoin de générer un jeton d’accès utilisateur), ce champ est ignoré. Si votre application utilise le flux d’appareil au lieu du flux d’application web pour générer un jeton d’accès utilisateur, ce champ est ignoré.

   Pour plus d’informations sur l’URL de rappel, consultez « À propos de l’URL de rappel d’autorisation utilisateur ». Pour plus d’informations sur la génération d’un jeton d’accès utilisateur pour agir au nom d’un utilisateur, consultez « Authentification auprès d’une application GitHub pour le compte d’un utilisateur » et « Génération d’un jeton d’accès utilisateur pour une application GitHub ».

10. Si vous le souhaitez, pour empêcher que les jetons d’accès utilisateur n’expirent, désélectionnez Faire expirer les jetons d’autorisation utilisateur. GitHub vous recommande vivement de laisser cette option sélectionnée. Pour plus d’informations sur l’actualisation des jetons expirés et les avantages des jetons d’accès utilisateur qui expirent, consultez « Actualisation des jetons d’accès utilisateur ». Si votre application n’a pas besoin de générer un jeton d’accès utilisateur, ce champ est ignoré.

11. Si vous le souhaitez, pour inviter les utilisateurs à autoriser votre application lorsqu’ils l’installent, sélectionnez Demander une autorisation utilisateur (OAuth) pendant l’installation. Si un utilisateur autorise votre application, celle-ci peut générer un jeton d’accès utilisateur afin d’effectuer des demandes d’API au nom de l’utilisateur et d’attribuer l’activité de l’application à l’utilisateur. Pour plus d’informations, consultez « Authentification auprès d’une application GitHub pour le compte d’un utilisateur » et « Génération d’un jeton d’accès utilisateur pour une application GitHub ».

12. Si vous souhaitez utiliser le flux d’appareil pour générer un jeton d’accès utilisateur, sélectionnez Activer le flux d’appareil. Pour plus d’informations, consultez « Génération d’un jeton d’accès utilisateur pour une application GitHub ».

13. Si vous le souhaitez, sous « URL de configuration », entrez l’URL vers laquelle rediriger les utilisateurs après avoir installé votre application. Si une configuration supplémentaire est nécessaire après l’installation, vous pouvez utiliser cette URL pour indiquer aux utilisateurs les étapes à suivre après l’installation. Pour plus d’informations, consultez « À propos de l’URL d’installation ».

    Si vous avez sélectionné Demander une autorisation utilisateur (OAuth) pendant l’installation à une étape antérieure, vous ne pourrez pas entrer d’URL ici. Les utilisateurs seront plutôt redirigés vers l’URL de rappel dans le cadre du flux d’autorisation, où vous pouvez décrire une configuration supplémentaire.

14. Si vous souhaitez rediriger les utilisateurs vers l’URL de configuration après avoir mis à jour une installation, sélectionnez Rediriger lors de la mise à jour. Une mise à jour comprend l’ajout ou la suppression d’un dépôt pour une installation. Si « URL de configuration » est vide, cette option est ignorée.

15. Si vous ne souhaitez pas que votre application reçoive des événements de webhook, désélectionnez Actif. Par exemple, si votre application est utilisée uniquement pour l’authentification ou si elle n’a pas besoin de répondre aux webhooks, désélectionnez cette option. Pour plus d’informations, consultez « Utilisation de webhooks avec des applications GitHub ».

16. Si vous avez sélectionné Actif à l’étape précédente, sous « URL de webhook », entrez l’URL à laquelle GitHub doit envoyer les événements de webhook. Pour plus d’informations, consultez « Utilisation de webhooks avec des applications GitHub ».

17. Si vous avez sélectionné Actif à l’étape précédente, sous « Secret de webhook », entrez un jeton secret pour sécuriser vos webhooks. GitHub vous recommande vivement de définir un secret de webhook. Pour plus d’informations, consultez « Utilisation de webhooks avec des applications GitHub ».

18. Si vous avez entré une URL de webhook, sous « Vérification SSL », sélectionnez si vous souhaitez activer une vérification SSL. GitHub vous recommande vivement d’activer la vérification SSL.

19. Sous « Autorisations », choisissez les autorisations dont a besoin votre application. Pour chaque autorisation, sélectionnez le menu déroulant et cliquez sur Lecture seule, Lecture et écriture ou Aucun accès. Vous devez sélectionner les autorisations minimales nécessaires pour votre application. Pour plus d’informations, consultez « Choix des autorisations pour une application GitHub ».

20. Si vous avez sélectionné Actif à l’étape précédente pour indiquer que votre application doit recevoir des événements de webhook, sous « S’abonner à des événements », sélectionnez les événements de webhook que vous souhaitez que votre application reçoive. Les autorisations que vous avez sélectionnées à l’étape précédente déterminent les événements de webhook disponibles. Pour plus d’informations sur chaque événement de webhook, consultez « Événements et charges utiles du webhook ».

21. Sous la section Où cette application GitHub peut-elle être installée ?, sélectionnez Uniquement sur ce compte ou Sur n’importe quel compte. Pour plus d’informations sur les options d’installation, consultez « Rendre une application GitHub publique ou privée ».

22. Cliquez sur Créer une application GitHub.

Étapes suivantes

Après avoir inscrit une GitHub App, vous souhaiterez écrire du code pour que votre GitHub App fasse quelque chose. Pour obtenir des exemples d’écriture de code, consultez :

• « Démarrage rapide pour la création d’applications GitHub »
• « Génération d’une application GitHub qui répond aux événements de webhook »
• « Création d’un bouton « Se connecter avec GitHub » avec une application GitHub App »
• « Création d’une interface CLI avec une application GitHub App »
• « Effectuer des requêtes d’API authentifiées avec une application GitHub dans un workflow GitHub Actions »

Vous devez vous efforcer de suivre les meilleures pratiques. Pour plus d’informations, consultez « Meilleures pratiques pour la création d’une application GitHub ».

Une fois que votre GitHub App est entièrement générée, vous pouvez installer votre GitHub App et partager votre GitHub App avec d’autres personnes. Pour plus d’informations, consultez « Installation de votre propre application GitHub » et « Partage de votre application GitHub ».

Vous pouvez toujours apporter des modifications aux paramètres de votre GitHub App. Pour plus d’informations, consultez « Modification d’une inscription d’application GitHub ».