Remarque : Votre GitHub App aura accès à tous les référentiels créés par l’application, même si quelqu’un installe uniquement votre application sur les référentiels sélectionnés.
Installation de votre application GitHub privée sur votre référentiel
Une fois que vous avez créé une application GitHub privée, vous pouvez l’installer sur l’un de vos référentiels d’organisation ou d’utilisateurs. Pour plus d’informations, consultez « Rendre une application GitHub publique ou privée ».
- Dans la page des paramètres des applications GitHub, sélectionnez votre application.
- Dans la barre latérale gauche, cliquez sur Installer l’application.
- Cliquez sur Installer en regard de l’organisation ou du compte personnel contenant le référentiel approprié.
- Sélectionnez Tous les dépôts ou Uniquement les dépôts sélectionnés.
- Si vous avez choisi « Uniquement les dépôts sélectionnés », sélectionnez le menu déroulant Sélectionner les dépôts et cliquez sur les dépôts dans lesquels vous souhaitez installer l’application.
- Cliquez sur Installer. Une fois l’installation terminée, vous verrez les options de configuration de l’application sur votre compte sélectionné. Vous pouvez apporter des modifications ici ou répéter les étapes précédentes pour installer l’application sur un autre compte.
Offre de votre application dans la Place de marché GitHub
Vous pouvez proposer une version payante ou gratuite de votre application dans GitHub Marketplace, où les utilisateurs peuvent rechercher et afficher des détails sur votre application. GitHub Marketplace installe automatiquement une application GitHub lorsqu’une commande est terminée.
Consultez « À propos de GitHub Marketplace » pour en savoir plus sur la façon de répertorier votre application sur GitHub Marketplace.
Pour en savoir plus sur la façon dont les utilisateurs peuvent installer votre application à partir de GitHub Marketplace, consultez « Utilisation d’applications GitHub ».
Autoriser les utilisateurs à installer votre application publique sur leur référentiel
Vous pouvez autoriser d’autres utilisateurs à installer votre application publique en fournissant l’URL d’installation dans des emplacements tels que la page d’accueil de votre application. Vous pouvez ensuite pointer vers la page d’accueil de votre application à partir de la page d’arrivée de GitHub.
Si vous migrez d’une application OAuth vers une application GitHub, vous pouvez utiliser des paramètres de requête pour présélectionner les référentiels et le compte lors de l’installation de l’application GitHub. Pour en savoir plus, consultez Migration d’applications OAuth vers des applications GitHub.
Ces étapes supposent que vous avez généré un GitHub App :
- Dans la page des paramètres des applications GitHub, sélectionnez l’application publique que vous souhaitez configurer pour que d’autres utilisateurs puissent l’installer.
- Dans l’onglet « Général », sous « URL de la page d’accueil », tapez l’URL de la page d’accueil de votre application, puis cliquez sur Enregistrer les modifications.
- GitHub fournit une page d’arrivée pour votre application qui inclut un lien vers l'« URL de la page d’accueil » de votre application. Pour visiter la page d’arrivée de GitHub, copiez l’URL du lien public et collez-la dans un navigateur.
- Créez une page d’accueil pour votre application qui inclut l’URL d’installation de l’application :
https://github.com/apps/<app name>/installations/new.
Autorisation des utilisateurs lors de l’installation
Vous pouvez simplifier le processus d’autorisation en l’effectuant lors de l’installation de l’application. Pour ce faire, sélectionnez Demander une autorisation utilisateur (OAuth) lors de l’installation pendant la création ou la modification de votre application dans GitHub. Pour en savoir plus, consultez Création d’une application GitHub.
Une fois qu’une personne a installé votre application, vous devez obtenir un jeton d’accès pour l’utilisateur. Pour en savoir plus, consultez les étapes 2 et 3 dans « Authentification auprès d’une application GitHub pour le compte d’un utilisateur ».
Conservation de l’état d’une application pendant l’installation
Vous pouvez fournir un paramètre state dans l’URL d’installation d’une application pour conserver l’état de la page de l’application et renvoyer les personnes à cet état une fois qu’elles ont installé, authentifié ou accepté les mises à jour de votre application GitHub. Par exemple, vous pouvez utiliser state pour mettre en corrélation une installation sur un utilisateur ou un compte.
Pour conserver un état, ajoutez-le à l’URL d’installation :
https://github.com/apps/<app name>/installations/new?state=AB12t