Prérequis
Avant d’écrire du code pour une GitHub App, vous devez inscrire une GitHub App. Quand vous inscrivez votre GitHub App, vous sélectionnez des autorisations pour elle. Ces autorisations dictent ce que votre GitHub App peut faire. Lorsque vous inscrivez une application, vous spécifiez également d’autres paramètres, notamment les événements de webhook que votre GitHub App doit recevoir. Vous pouvez toujours modifier les paramètres de votre inscription d’GitHub App. Pour plus d’informations, consultez « Inscription d’une application GitHub » et « Modification d’une inscription d’application GitHub ».
Si vous souhaitez que votre GitHub App accède au dépôt et/ou aux données de l’organisation, vous devez installer votre GitHub App. Pour plus d’informations, consultez « Installation de votre propre application GitHub ».
Écriture de code pour une GitHub App
Pour que votre GitHub App fasse quelque chose, vous devez écrire du code pour ajouter des fonctionnalités à votre GitHub App.
Pour obtenir des tutoriels sur l’écriture de code pour une GitHub App, 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 »
Vous pouvez utiliser les informations d’identification de votre inscription d’GitHub App pour effectuer des requêtes authentifiées auprès des API GitHub. Pour plus d’informations, consultez « À propos de l’authentification avec une application GitHub ».
Pendant le développement, vous utiliserez probablement votre ordinateur personnel ou codespace pour exécuter votre GitHub App. Vous devrez peut-être apporter des modifications à votre inscription d’GitHub App pendant le développement :
-
Si votre application reçoit des webhooks, vous pouvez utiliser une URL de proxy de webhook pour transférer des webhooks de GitHub vers votre ordinateur ou codespace. Vous devez mettre à jour le paramètre « URL du webhook » dans votre inscription d’GitHub App pour utiliser votre URL de proxy de webhook. Pour obtenir un exemple, consultez « Génération 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 inscription d’GitHub App pour utiliser une URL de rappel locale. Pour obtenir un exemple, consultez « Création d’un bouton « Se connecter avec GitHub » avec une application GitHub App ».
É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 inscription d’GitHub App. Si votre GitHub App doit s’exécuter sur un serveur plutôt que sur l’appareil d’un utilisateur, déployez votre application sur votre serveur. Enfin, vous pouvez partager votre GitHub App avec d’autres utilisateurs et organisations.
Suivre les bonnes pratiques
Avant de déployer votre GitHub App, veillez à suivre les meilleures pratiques. Par exemple, assurez-vous que les informations d’identification de votre GitHub App sont sécurisées. Pour plus d’informations, consultez « Meilleures pratiques pour la création d’une application GitHub ».
Mettre à jour votre inscription d’GitHub App
Si vous avez modifié l’inscription d’GitHub App pour le développement, veillez à mettre à jour l’inscription pour utiliser des valeurs prêtes pour la production. Par exemple, si vous avez utilisé une URL de proxy de webhook pour le développement, vous devez mettre à jour le champ « URL du webhook » pour utiliser l’URL où vous souhaitez que vos données GitHub App reçoivent des webhooks pendant la production.
Déployer votre GitHub App
Une fois que vous avez écrit le code pour votre GitHub App, votre code 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.
Partager votre GitHub App
Si vous souhaitez partager votre GitHub App avec d’autres utilisateurs et organisations, vous devez rendre votre GitHub App publique. Pour plus d’informations, consultez « Partage de votre application GitHub ».