Prérequis
Avant d’écrire du code pour un GitHub App, vous devez inscrire un GitHub App. Lorsque vous inscrivez un GitHub App, vous sélectionnez des autorisations pour l’application. Ces autorisations déterminent ce que le GitHub App peut faire. Lorsque vous inscrivez une application, vous spécifiez également d’autres paramètres, y compris les événements webhook que vous GitHub App devez recevoir. Vous pouvez toujours modifier les paramètres de votre GitHub App inscription. Pour plus d’informations, consultez « Inscription d’une application GitHub » et « Modification d’une inscription d’application GitHub ».
Si vous voulez que votre GitHub App accède aux données du dépôt et/ou de l’organisation, vous devez installer votre GitHub App. Pour plus d’informations, consultez « Installation de votre propre application GitHub ».
Écriture de code pour un GitHub App
Pour que vous GitHub App fassiez quelque chose, vous devez écrire du code pour ajouter des fonctionnalités à votre GitHub App.
Pour obtenir des didacticiels sur l’écriture de code pour un GitHub App, consultez :
- Démarrage rapide pour la création d’applications GitHub
- Création d’une application GitHub qui répond aux événements de webhook
- Création d’un bouton « Connexion avec GitHub » avec une application GitHub
- Création d’une interface CLI avec une application GitHub
Vous pouvez utiliser les informations d’identification de votre GitHub App inscription pour effectuer des demandes authentifiées auprès GitHubdes API. Pour plus d’informations, consultez « À propos de l’authentification avec une application GitHub ».
Pendant le développement, vous utiliserez probablement votre ordinateur personnel ou votre espace de code pour exécuter votre GitHub App. Vous devrez peut-être apporter des modifications à votre GitHub App inscription pendant le développement :
-
Si votre application reçoit des webhooks, vous pouvez utiliser une URL de proxy webhook pour transférer des webhooks de GitHub à votre ordinateur ou espace de code. Vous devez mettre à jour le paramètre « URL du webhook » dans votre GitHub App inscription pour utiliser votre URL de proxy webhook. Pour obtenir un exemple, consultez « Création d’une application GitHub qui répond aux événements de webhook ».
-
Si votre application utilise le flux d’application web pour autoriser un utilisateur, vous pouvez mettre à jour le paramètre « URL de rappel » dans votre GitHub App inscription pour utiliser une URL de rappel locale. Pour obtenir un exemple, consultez « Création d’un bouton « Connexion avec GitHub » avec une application GitHub ».
Étapes suivantes
Une fois que vous avez écrit le code pour votre GitHub App, vous devez vous assurer qu’il suit les meilleures pratiques. Si nécessaire, n’oubliez pas de mettre à jour votre GitHub App inscription. Si votre GitHub App doit s’exécuter sur un serveur au lieu de l’appareil d’un utilisateur, déployez votre application sur votre serveur. Enfin, vous pouvez partager vos GitHub App données avec d’autres utilisateurs et organisations.
Suivre les bonnes pratiques
Avant de déployer votre GitHub App, veillez à suivre les bonnes pratiques. Par exemple, assurez-vous que vos GitHub Appinformations d’identification sont sécurisées. Pour plus d’informations, consultez « Meilleures pratiques pour la création d’une application GitHub ».
Mettre à jour votre GitHub App inscription
Si vous avez modifié l’GitHub Appenregistrement à des fins de développement, veillez à le mettre à jour pour utiliser des valeurs adaptées à la production. Par exemple, si vous avez utilisé une URL de proxy webhook pour le développement, vous devez mettre à jour le champ « URL du webhook » pour utiliser l’URL dans laquelle vous souhaitez GitHub App recevoir des webhooks pendant la production.
Déployez votre GitHub App
Une fois que vous avez écrit le code de votre GitHub App, celui-ci doit s’exécuter quelque part. Si votre application est un site web ou une application web, vous pouvez héberger votre application sur un serveur comme Azure App Service. Si votre application est une application côté client, elle peut s’exécuter sur l’appareil d’un utilisateur.
Partagez votre GitHub App
Si vous souhaitez partager vos GitHub App données avec d’autres utilisateurs et organisations, vous devez rendre votre GitHub App public. Pour plus d’informations, consultez Partage de votre application GitHub.