Créez une automatisation Mintlify déclenchée par un calendrier, un push sur un dépôt ou un événement d’intégration, avec contexte et prompt dédiés.
Une automatisation personnalisée exécute l’agent selon un calendrier, en réponse à des pushes sur un dépôt ou lorsqu’un événement survient dans une intégration connectée, en utilisant les instructions que vous rédigez. Utilisez une automatisation personnalisée lorsque vous avez besoin d’un comportement non couvert par une automatisation prédéfinie, ou lorsque vous souhaitez combiner votre propre prompt avec des dépôts de contexte et des intégrations spécifiques. Pour un aperçu des déclencheurs, des modes de mise à jour et des options de configuration communs à toutes les automatisations, consultez Automatisations.
L’agent s’exécute dans un sandbox isolé avec un accès Internet restreint. Il ne peut pas installer de packages ou d’outils supplémentaires à l’exécution. Les prompts qui font référence à des outils indisponibles peuvent produire des résultats inattendus ou échouer.
Configurez le nom de l’automatisation, le déclencheur, les instructions, les dépôts de contexte, les intégrations et le mode de mise à jour. Pour plus de détails sur chaque champ, consultez Configurations.
Cliquez sur Create automation.
Vous pouvez également demander à l’agent dans Slack de créer une automatisation pour vous en décrivant ce que vous souhaitez qu’elle fasse.
Des instructions d’automatisation efficaces se concentrent sur une seule tâche et définissent un résultat clair et vérifiable. Les automatisations présentent une certaine variabilité car les agents sont non déterministes, mais des instructions bien formulées produisent des résultats plus cohérents.
Décrivez le résultat. Indiquez à l’agent à quoi devrait ressembler une exécution réussie.
Rédigez une procédure. Donnez à l’agent un guide étape par étape à suivre.
Restez précis dans la portée. Divisez les tâches complexes en plusieurs automatisations plutôt que de les combiner dans un seul prompt.
Vérifiez les résultats de vos automatisations personnalisées pour confirmer qu’elles fonctionnent comme prévu. Mettez à jour vos instructions pour améliorer les résultats.
Pour utiliser des dépôts GitLab dans une automatisation, connectez chaque projet via la page de paramètres OAuth GitLab. Connectez chaque dépôt que l’automatisation utilise — votre dépôt de documentation et tous les dépôts de déclenchement ou de contexte. Vous devez disposer au minimum du rôle Mainteneur sur chaque projet.
Les automatisations nécessitent un forfait GitLab payant. L’agent utilise des jetons d’accès de projet à courte durée de vie pour l’accès aux dépôts, ce que le forfait gratuit de GitLab ne prend pas en charge.
Pour utiliser des dépôts Bitbucket dans une automatisation, connectez votre compte Bitbucket via les paramètres OAuth Bitbucket de votre dashboard Mintlify. Autorisez Mintlify à accéder à vos espaces de travail Bitbucket, puis sélectionnez les espaces de travail et les dépôts que l’automatisation peut utiliser.Mintlify répertorie les dépôts auxquels votre compte Bitbucket dispose d’un accès contributeur. Connectez les dépôts utilisés par l’automatisation pour le contenu, les déclencheurs de modification de code ou le contexte. Mintlify enregistre un webhook pour chaque dépôt connecté afin que les événements du dépôt puissent déclencher des automatisations.Avant de configurer un dépôt Bitbucket connecté comme source Git d’un déploiement, connectez ce dépôt dans les paramètres OAuth Bitbucket. Mintlify exige que le dépôt fasse partie d’une installation Bitbucket active pour pouvoir l’utiliser comme source Git.
Ouvrez les paramètres Git dans votre dashboard, sélectionnez Connect to Bitbucket, puis cliquez sur Continue.
Si Mintlify héberge actuellement votre documentation, cliquez sur Download pour enregistrer votre contenu dans un fichier zip. Créez un dépôt Bitbucket, importez le contenu du fichier zip, puis cliquez sur Continue setup. La connexion de votre propre dépôt supprime définitivement le contenu hébergé. Téléchargez-le avant de continuer.
Cliquez sur Connect Bitbucket et autorisez Mintlify à accéder à votre espace de travail et à votre dépôt.
Saisissez le slug de l’espace de travail Bitbucket, le slug du dépôt et la branche de déploiement. Si docs.json se trouve dans un sous-répertoire, activez Docs are in a subdirectory et saisissez le chemin vers le répertoire contenant docs.json.
Cliquez sur Connect.
Pour un dépôt connecté et configuré comme source Git d’un déploiement, les pushs vers la branche configurée déclenchent des déploiements. Mintlify utilise les fichiers modifiés pour effectuer des mises à jour incrémentielles lorsqu’il peut déterminer le diff. Il effectue une mise à jour complète lorsqu’il ne peut pas déterminer les fichiers modifiés ou lorsque la modification affecte l’ensemble du site.Si les déploiements de prévisualisation sont activés, les pull requests qui modifient le contenu de la documentation peuvent créer des déploiements de prévisualisation. La fermeture d’une pull request ou la suppression de sa branche source supprime le déploiement de prévisualisation correspondant. La fusion d’une pull request nettoie sa branche d’éditeur associée.Mintlify vérifie la signature des webhooks avant de traiter les événements. Les requêtes sans signature valide sont rejetées. Les événements provenant de dépôts non reconnus sont ignorés.Pour cesser d’utiliser un dépôt, déconnectez-le des paramètres OAuth Bitbucket. Vous pouvez également supprimer l’installation Bitbucket pour déconnecter tous les dépôts associés à cette autorisation.
