Passer au contenu principal

​
Prérequis

  • 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)
Vous pouvez également créer, lister et supprimer des automatisations depuis le terminal avec mint automation. La CLI est utile pour les scripts et la CI ; le dashboard est le moyen le plus simple de configurer et de surveiller les exécutions d’automatisations.

​
Activer une automatisation

  1. Ouvrez la page Automations dans votre dashboard.
  2. Cliquez sur le bouton bascule à côté d’une automatisation pour l’activer.
    Le dashboard des automatisations.
    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.
    Les options de configuration d'une automatisation.
  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.

​
Configurations

​
Déclencheur

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.

​
Mode de mise à jour

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 dépôts GitHub, les mises à jour automatiques nécessitent que la GitHub App Mintlify dispose d’autorisations de contournement (bypass) sur chaque ensemble de règles ciblant votre branche de déploiement, y compris les ensembles de règles au niveau de l’organisation et du dépôt. Consultez Configurer l’automerge pour les instructions d’installation.Pour les dépôts GitLab, l’automerge utilise la connexion OAuth GitLab et nécessite au moins le rôle Maintainer sur chaque projet.

​
Dépôts de contexte

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.

​
Intégrations

Pour les automatisations personnalisées et l’automatisation Update from code changes, vous pouvez activer les intégrations de l’agent connectées afin que l’agent puisse récupérer du contexte depuis des outils comme Slack, Notion ou Linear lorsque l’automatisation s’exécute. Pour activer les intégrations d’une automatisation, ouvrez ses paramètres et sélectionnez les intégrations que vous souhaitez que l’agent utilise dans la section Available integrations. Seules les intégrations déjà connectées pour votre organisation apparaissent dans la liste. Consultez Intégrations de l’agent pour plus d’informations sur la connexion des intégrations.

​
Notifications Slack

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 Turn on Slack notifications sur la page Automations de votre dashboard.
    Le bouton d'activation des notifications Slack.
  3. Sélectionnez un ou plusieurs canaux de notification.
  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.

​
Instructions

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.

​
Langues cibles

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.

​
Désactiver une automatisation

  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.

​
Consulter 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. Accédez à la page Automation Runs dans votre dashboard.
  2. Utilisez les menus déroulants pour filtrer par automatisations spécifiques ou par statut.
    Page des exécutions d'automatisations montrant les filtres par automatisation et par statut.

Sujets connexes

Utiliser les automatisationsCréer et modifier des pagesCommentaires