GitHub
Connectez votre dépôt GitHub à Mintlify pour des déploiements automatiques, des aperçus de pull requests et une synchronisation continue de la documentation.
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 est un référentiel privé appartenant à l’organisation Mintlify, 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.
Si vous avez omis de connecter votre propre référentiel Git lors de l’onboarding, votre documentation se trouve dans un référentiel privé appartenant à l’organisation Mintlify. Pour la déplacer vers votre propre compte ou organisation, allez dans Git Settings dans votre Dashboard. Un assistant de configuration vous guide à travers le processus avec deux options :
Après avoir suivi l’une ou l’autre option, installez la GitHub App en suivant les étapes décrites dans 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.
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 documentationdeployments: 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.
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 ou les workflows. Vous pouvez modifier cette sélection à tout moment dans vos paramètres de l’application GitHub.
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.
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.
Si vos pushes vers votre référentiel ne déclenchent pas de déploiements, vérifiez les points suivants.
Si vous rencontrez des problèmes avec l’application GitHub, réinitialiser la connexion permet de résoudre la plupart des problèmes.
Désinstallez l’application Mintlify via GitHub.
- 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.
- Allez sur Authorized GitHub Apps et sélectionnez Revoke à côté de l’application Mintlify.
Réinstallez l’application Mintlify.
- Dans votre tableau de bord Mintlify, allez dans Git Settings et installez la GitHub App.
- Autorisez votre compte dans la section My Profile de votre tableau de bord.
Les fonctionnalités de feedback « suggestions d’édition » et « signalement de problèmes » ne sont disponibles que pour les référentiels GitHub publics. Si ces options sont indisponibles dans votre Tableau de bord Mintlify, vérifiez la visibilité de votre référentiel.
Si votre référentiel est public et que vous ne pouvez pas activer les options de suggestions d’édition ou de signalement de problèmes dans votre Tableau de bord Mintlify, revalidez vos paramètres Git.
Accéder aux paramètres Git
Accédez aux paramètres Git dans votre Tableau de bord Mintlify.
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é.