Gérer les automatisations

• Un projet Mintlify connecté à un dépôt GitHub ou GitLab
• Pour GitHub : la GitHub App Mintlify installée sur chaque dépôt que vous prévoyez d’utiliser dans l’automatisation
• Pour GitLab : un compte GitLab connecté (voir Configuration GitLab ci-dessous)

1. Ouvrez la page Automations dans votre dashboard.
2. Cliquez sur le bouton bascule à côté d’une automatisation pour l’activer.
   
   Si l’automatisation peut s’exécuter avec les paramètres par défaut, elle s’active immédiatement. Sinon, le panneau de paramètres s’ouvre pour vous permettre de remplir les configurations requises.
   
3. Si le panneau de paramètres s’ouvre, remplissez les champs requis.
4. Cliquez sur Turn on automation.

Pour modifier les paramètres d’une automatisation active, cliquez sur le bouton de paramètres à côté de celle-ci. Utilisez le bouton bascule dans l’en-tête de la modale pour activer ou désactiver l’automatisation sans quitter la vue des paramètres. Chaque automatisation possède un déclencheur par défaut qui contrôle son moment d’exécution. Pour changer le déclencheur, sélectionnez une autre option dans le panneau des paramètres.

• Mise à jour de contenu : s’exécute chaque fois que vous poussez du contenu vers le dépôt de votre projet, y compris les fusions de pull requests et les pushes directs.
• Modification de code : s’exécute lorsqu’une pull request est fusionnée dans un dépôt de code source connecté. Vous devez spécifier au moins un dépôt source.
• Calendrier personnalisé : s’exécute selon un calendrier récurrent que vous définissez. Les automatisations sont mises en file d’attente dans les 10 minutes suivant l’heure planifiée.
• Intégration : s’exécute lorsqu’un événement sélectionné se produit dans une intégration partagée connectée. Disponible pour les automatisations personnalisées. Sélectionnez l’intégration et l’événement, puis remplissez les champs supplémentaires affichés.
• Message Slack : s’exécute lorsqu’un coéquipier publie un message de premier niveau dans l’un des canaux Slack sélectionnés. Disponible pour les automatisations personnalisées. Nécessite l’application Slack Mintlify. Sélectionnez un ou plusieurs canaux à surveiller. Le déclencheur ignore les réponses de fil, les modifications et les messages provenant de bots ou de l’application Mintlify elle-même. L’agent lit chaque nouveau message et décide s’il doit agir.

Chaque automatisation possède un mode par défaut pour effectuer les mises à jour. Soit fusionner directement les modifications dans votre dépôt de contenu, soit ouvrir une pull request pour relecture. Pour exiger une relecture avant que l’automatisation ne mette à jour votre contenu, sélectionnez Require review dans le panneau des paramètres. Pour les automatisations personnalisées et certaines automatisations prédéfinies, vous pouvez ajouter des dépôts de contexte — des dépôts de code source supplémentaires que l’agent lit lorsque l’automatisation s’exécute. C’est utile lorsque le prompt de votre automatisation fait référence à du code, des API ou d’autres contenus qui se trouvent en dehors de votre dépôt de projet. Vous pouvez ajouter jusqu’à 10 dépôts de contexte par automatisation. Pour chaque dépôt GitHub, installez la GitHub App Mintlify. Ajoutez des dépôts sur la page GitHub App settings. Pour les automatisations personnalisées et les autres automatisations prédéfinies compatibles, vous pouvez activer des intégrations afin que l’agent récupère du contexte depuis des outils partagés comme Notion, Jira ou Linear. Ouvrez les paramètres de l’automatisation et sélectionnez les intégrations dans Tools. Vous pouvez connecter une intégration partagée depuis le sélecteur. Les intégrations personnelles ne sont disponibles que pour leur propriétaire lorsqu’il utilise l’agent Slack et ne peuvent pas être ajoutées aux automatisations. Si vous sélectionnez Intégration comme déclencheur, l’intégration déclencheuse est automatiquement ajoutée comme outil. Consultez Intégrations pour les portées, événements et autorisations. Envoyez des messages Slack à un ou plusieurs canaux lorsque les automatisations s’exécutent. Pour activer les notifications Slack :

1. Installez l’application Slack Mintlify dans votre espace de travail.
2. Cliquez sur Configure Slack sur la page Automations de votre dashboard.
3. Sélectionnez un ou plusieurs canaux vers lesquels envoyer les notifications.
4. Cliquez sur Save changes.

Une fois activé, Mintlify publie dans les canaux sélectionnés lorsque :

• Une automatisation ouvre une pull request pour relecture.
• Une pull request d’automatisation attend une relecture depuis trois jours.
• Une automatisation fusionne une pull request, ou échoue à se terminer.

Ajoutez des instructions facultatives qui s’ajoutent au prompt de base de l’automatisation à chaque exécution. Utilisez-les pour ajuster le style, le ton ou d’autres comportements spécifiques au projet sans modifier la logique principale de l’automatisation. Lorsque vous activez l’automatisation Translate content, sélectionnez une ou plusieurs langues à maintenir en synchronisation avec votre contenu source.

• Mintlify lit les langues définies dans votre docs.json pour identifier votre langue par défaut et présélectionne les langues cibles déjà configurées.
• Vous devez sélectionner au moins une langue cible pour enregistrer l’automatisation.
• Vous ne pouvez pas sélectionner la langue source comme cible.

Vous pouvez ajouter des langues cibles à tout moment en ouvrant les paramètres de l’automatisation et en modifiant le champ Translate to.

​

Configuration GitLab

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.

1. Accédez à la page Automations dans votre dashboard.
2. Cliquez sur le bouton bascule à côté d’une automatisation pour la désactiver.

Lorsque vous réactivez une automatisation planifiée ou modifiez son calendrier, Mintlify recalcule la prochaine heure d’exécution à partir de l’heure actuelle. Les automatisations désactivées ne conservent pas d’heure d’exécution en attente. Vous pouvez déclencher toute automatisation activée à la demande sans attendre sa prochaine exécution planifiée ou déclenchée par un événement.

1. Ouvrez la page Automations dans votre dashboard.
2. Cliquez sur le bouton d’exécution à côté de l’automatisation que vous souhaitez démarrer.

Les exécutions manuelles utilisent la configuration actuelle de l’automatisation, sont décomptées de votre utilisation de crédits et apparaissent dans l’historique des exécutions aux côtés des exécutions planifiées. Pour les automatisations avec un déclencheur Calendrier personnalisé, vous pouvez démarrer une exécution depuis vos propres outils au lieu d’attendre la prochaine heure planifiée. Utilisez l’endpoint Trigger automation pour déclencher une exécution depuis un pipeline CI/CD, un script de version ou tout service capable de faire une requête HTTP authentifiée. Les exécutions déclenchées par API se comportent exactement comme les exécutions planifiées : elles récupèrent tout ce qui a changé depuis la dernière exécution terminée, sont décomptées de votre utilisation de crédits et apparaissent dans l’historique des exécutions. Chaque automatisation conserve un journal des exécutions passées, incluant le statut et un résumé des modifications effectuées.

1. Ouvrez la page Automations dans votre dashboard.
2. Utilisez les menus déroulants pour filtrer par automatisations spécifiques ou par statut.

Chaque exécution affiche l’un des statuts suivants :

• Review needed : l’agent a terminé l’exécution, mais les modifications doivent être relues et fusionnées par une personne de votre équipe.
• Running : l’agent travaille activement sur la tâche d’automatisation.
• Accepted : l’agent a terminé l’exécution et les modifications ont été fusionnées dans votre dépôt.
• Closed : l’agent a terminé l’exécution, mais quelqu’un a rejeté les modifications.
• Failed : l’agent n’a pas pu terminer l’exécution. Les exécutions en échec ne comptent pas dans votre limite quotidienne d’exécutions.
• No action needed : l’agent a terminé l’exécution mais n’a rien trouvé à mettre à jour.

Cliquez sur une exécution individuelle pour voir son prompt, les fichiers qu’elle a lus ou modifiés, et toute pull request qu’elle a ouverte. Lorsqu’une automatisation se termine et crée des modifications sur une branche, vous pouvez ouvrir ces modifications directement dans l’éditeur pour les examiner, les affiner ou les publier.

1. Ouvrez la page Automations dans votre dashboard.
2. Cliquez sur View changes à côté de l’exécution du workflow sur laquelle vous souhaitez continuer à travailler dans l’éditeur.

L’éditeur s’ouvre sur la branche de l’automatisation avec le panneau de l’agent déjà ouvert. Le panneau de l’agent affiche chaque page modifiée par l’automatisation. Cliquez sur une page pour voir les modifications effectuées par l’automatisation. L’agent de l’éditeur dispose d’un contexte complet sur ce que l’automatisation a fait, y compris son prompt, un résumé des modifications et les pages modifiées. Demandez à l’agent d’affiner ou d’étendre ce travail sans avoir à réexpliquer le contexte.