L’éditeur prend en charge deux workflows pour publier des mises à jour de la documentation. Le workflow que vous utilisez dépend des règles de protection des branches de votre référentiel et de la branche sur laquelle vous travaillez.Créer des pull requests : Si votre référentiel comporte une règle de protection de branche qui impose des pull requests avant que les modifications puissent être fusionnées dans votre branche de déploiement, l’éditeur crée une pull request (demande de fusion) lorsque vous publiez des modifications.
Lorsque vous créez une pull request depuis l’éditeur, l’agent Mintlify génère un titre et une description en fonction de vos modifications. Vous pouvez modifier le titre et la description générés avant de créer la pull request.
Publier directement : Si votre référentiel n’a aucune règle de protection de branche, vos modifications sont fusionnées dans la branche de déploiement et déployées immédiatement lorsque vous publiez.
Type de branche
Protection de la branche
Workflow de publication
Aucune
Effectue des commits et déploie les modifications
Branche de déploiement
Pull requests requises
Crée une pull request (demande de fusion)
Aucune
Fusionne les modifications dans la branche de déploiement et les déploie
Branche de fonctionnalité
Pull requests requises
Crée une pull request (demande de fusion)
Configurez des règles de protection des branches dans votre fournisseur Git pour exiger des pull requests. Voir À propos des branches protégées dans la documentation GitHub ou Branches protégées dans la documentation GitLab.
Cliquez sur Publier dans la barre d’outils. Selon votre workflow, vos modifications sont déployées immédiatement ou créent une pull request à fusionner dans votre fournisseur Git. Si vous êtes sur une branche de fonctionnalité, enregistrez vos modifications avant de publier.S’il n’y a aucune modification en attente ou si une pull request est déjà ouverte pour la branche actuelle, le bouton Publier n’est pas cliquable.
Votre site de documentation en production est mis à jour après que Mintlify a compilé et déployé vos modifications publiées. Cela prend généralement entre 30 secondes et quelques minutes. Vérifiez l’état du déploiement de vos modifications sur votre dashboard.
L’éditeur affiche des avertissements lorsque des conflits empêchent d’effectuer des opérations comme la publication ou le changement de branche. Pour résoudre les conflits, suivez les instructions dans l’éditeur pour choisir les modifications à conserver.
Signez vos commits avec votre compte GitHub en l’autorisant dans vos paramètres de compte. Sans cette autorisation, la GitHub App de Mintlify signe les commits effectués dans l’éditeur web.Attribuer les commits à votre compte permet de conserver un historique précis des personnes ayant modifié votre documentation.
