GitHub

Connectez un référentiel GitHub pour des déploiements automatisés, des aperçus de pull requests (demandes de fusion) et une synchronisation continue.

Mintlify utilise une GitHub App pour synchroniser automatiquement votre documentation avec votre référentiel GitHub.

Avez-vous besoin de la GitHub App ?

• Référentiel hébergé par Mintlify dans l’organisation mintlify-community : Non. La GitHub App est déjà configurée.
• Votre propre référentiel : Oui. Installez la GitHub App pour activer les déploiements automatisés lorsque vous poussez des modifications.

Consultez votre référentiel sur la page Git Settings de votre Dashboard.

Si votre référentiel se trouve dans l’organisation mintlify-community, la GitHub App est automatiquement configurée et gérée par Mintlify. Vous pouvez utiliser l’éditeur en ligne pour modifier votre documentation. Si vous souhaitez travailler sur votre documentation en local, clonez le référentiel dans votre propre organisation et mettez à jour vos paramètres Git pour utiliser votre propre référentiel.

​

Installer la GitHub App

Vous devez être propriétaire de l’organisation ou disposer des autorisations d’administrateur sur un référentiel pour installer l’application. Si vous n’avez pas les autorisations nécessaires, le propriétaire du référentiel doit approuver la demande d’installation.

Installez la GitHub App de Mintlify depuis votre Dashboard.

Nous recommandons d’accorder l’accès uniquement à votre référentiel de documentation.

​

Autorisations

Lorsque vous installez la GitHub App, accordez les autorisations suivantes.

Autorisations en lecture :

• metadata : Informations de base sur le référentiel

Autorisations en lecture et écriture :

• checks : Créer des contrôles d’état sur les pull requests (demandes de fusion)
• code : Lire les modifications de fichiers lorsque vous faites un commit sur votre branche de documentation
• deployments : Générer des déploiements de prévisualisation pour les pull requests (demandes de fusion)
• pull requests : Créer des branches et des pull requests (demandes de fusion) depuis l’éditeur web

L’app n’accède qu’aux référentiels auxquels vous lui avez explicitement accordé l’accès. Si vous avez activé des règles de protection de branche, l’app ne peut pas pousser directement vers des branches protégées.

​

Gérer l’accès aux référentiels

Lors de l’installation de la GitHub App, vous pouvez accorder l’accès à l’ensemble de vos référentiels ou uniquement à certains d’entre eux. Nous recommandons de n’accorder l’accès qu’à votre référentiel de documentation ainsi qu’aux référentiels que vous souhaitez utiliser comme contexte pour l’agent. Vous pouvez modifier cette sélection à tout moment dans vos paramètres de l’application GitHub.

​

Configurer la source de la documentation

Modifiez l’organisation, le référentiel ou la branche à partir desquels votre documentation est générée dans la section Git Settings de votre Dashboard.

​

GitHub Enterprise avec listes d’IP autorisées

Si l’allowlist d’IP est activée pour votre organisation GitHub Enterprise Cloud, vous devez ajouter l’adresse IP sortante de Mintlify (54.242.90.151) à votre liste d’IP autorisées pour que la GitHub App fonctionne correctement.

Suivez la documentation de GitHub pour configurer votre allowlist d’IP.

​

Résolution des problèmes

​

Le déploiement ne se déclenche pas automatiquement

Si vos pushes vers votre référentiel ne déclenchent pas de déploiements, vérifiez les points suivants.

Vérifier l'installation de la GitHub App

Vérifiez que la GitHub App est installée sur le bon référentiel.

1. Allez dans les paramètres de la GitHub App dans votre Dashboard.
2. Vérifiez que votre référentiel figure dans la liste des installations actives de l’app.

Vérifier la branche de déploiement

Assurez-vous que vous poussez vers la bonne branche.

1. Allez dans les paramètres Git
2. Vérifiez que la branche indiquée dans votre Dashboard correspond à la branche vers laquelle vous poussez.

​

Problèmes de connexion avec l’application GitHub

Si vous rencontrez des problèmes avec l’application GitHub, réinitialiser la connexion permet de résoudre la plupart des problèmes.

1. Désinstallez l’application Mintlify via GitHub.

   1. Dans GitHub, allez dans Installations et sélectionnez Configure à côté de l’application Mintlify. Faites défiler vers le bas et sélectionnez Uninstall.
   2. Allez sur Authorized GitHub Apps et sélectionnez Revoke à côté de l’application Mintlify.
2. Réinstallez l’application Mintlify.

   1. Dans votre tableau de bord Mintlify, allez dans Git Settings et installez la GitHub App.
   2. Autorisez votre compte dans la section My Profile de votre tableau de bord.

​

Les modules complémentaires de feedback sont indisponibles

Si vous ne pouvez pas activer les options de suggestions d’édition ou de signalement de problèmes dans votre Tableau de bord Mintlify et que votre référentiel est public, revalidez vos paramètres Git.

1. Accéder aux paramètres Git

   Accédez aux paramètres Git dans votre Tableau de bord Mintlify.

2. Revalider vos paramètres

   Cliquez sur la coche verte dans le coin du cadre des paramètres Git pour revalider les paramètres de votre référentiel. Cela force une mise à jour de vos paramètres afin de refléter si votre référentiel est public ou privé.