mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
dc82d98a90
Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
127 lines
7.9 KiB
Plaintext
127 lines
7.9 KiB
Plaintext
---
|
|
title: "Gérer les workflows"
|
|
description: "Activez, désactivez, déclenchez et supprimez des workflows depuis votre tableau de bord. Configurez des triggers GitHub ou GitLab, ajoutez des dépôts de contexte, définissez des planifications et activez l'automerge."
|
|
keywords: ["cron", "push", "automerge", "contexte", "instructions de workflow", "trigger", "désactiver un workflow", "activer un workflow"]
|
|
---
|
|
|
|
import GitlabWorkflowSetup from '/snippets/fr/gitlab-workflow-setup.mdx';
|
|
|
|
<div id="prerequisites">
|
|
## Prérequis
|
|
</div>
|
|
|
|
- Un projet Mintlify connecté à un dépôt GitHub ou GitLab
|
|
- Pour GitHub : l'[application GitHub Mintlify](/fr/deploy/github) installée sur chaque dépôt que vous prévoyez d'utiliser dans le workflow
|
|
- Pour GitLab : un compte GitLab connecté (voir [Configuration GitLab](#gitlab-setup) ci-dessous)
|
|
|
|
<Tip>
|
|
Vous pouvez également créer, lister et supprimer des workflows depuis le terminal avec [`mint workflow`](/fr/cli/commands#mint-workflow). La CLI est utile pour les scripts et l'intégration continue ; le tableau de bord est le moyen le plus simple de configurer et de surveiller les exécutions des workflows.
|
|
</Tip>
|
|
|
|
<div id="enable-a-workflow">
|
|
## Activer un workflow
|
|
</div>
|
|
|
|
1. Ouvrez la page [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) dans votre tableau de bord.
|
|
2. Cliquez sur l'interrupteur à côté d'un workflow pour l'activer.
|
|
<Frame>
|
|
<img src="/images/workflows/workflows-dashboard-light.png" alt="Le tableau de bord des workflows." className="block dark:hidden" />
|
|
<img src="/images/workflows/workflows-dashboard-dark.png" alt="Le tableau de bord des workflows." className="hidden dark:block" />
|
|
</Frame>
|
|
|
|
Si le workflow peut s'exécuter avec les paramètres par défaut, il s'active immédiatement. Sinon, le panneau de paramètres s'ouvre pour vous permettre de renseigner les configurations requises.
|
|
<Frame>
|
|
<img src="/images/workflows/workflow-settings-light.png" alt="Les options de configuration d'un workflow." className="block dark:hidden" />
|
|
<img src="/images/workflows/workflow-settings-dark.png" alt="Les options de configuration d'un workflow." className="hidden dark:block" />
|
|
</Frame>
|
|
3. Si le panneau de paramètres s'ouvre, renseignez les champs requis.
|
|
4. Cliquez sur **Turn on workflow**.
|
|
|
|
Pour modifier les paramètres d'un workflow actif, cliquez sur le bouton <Icon icon="settings" /> de paramètres à côté de celui-ci. Utilisez l'interrupteur dans l'en-tête du modal pour activer ou désactiver le workflow sans quitter la vue des paramètres.
|
|
|
|
<div id="configurations">
|
|
## Configurations
|
|
</div>
|
|
|
|
<div id="trigger">
|
|
### Trigger
|
|
</div>
|
|
|
|
Chaque workflow possède un trigger par défaut qui contrôle quand il s'exécute. Pour changer le trigger, sélectionnez une autre option dans le panneau de paramètres.
|
|
|
|
- **Mise à jour de contenu**—S'exécute chaque fois que vous poussez du contenu vers votre dépôt de projet, y compris les fusions de pull requests et les pushes directs.
|
|
- **Changement 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.
|
|
- **Planification personnalisée**—S'exécute selon une planification récurrente que vous définissez. Les workflows sont mis en file d'attente dans les 10 minutes suivant l'heure planifiée.
|
|
|
|
<div id="update-mode">
|
|
### Mode de mise à jour
|
|
</div>
|
|
|
|
Chaque workflow possède un mode par défaut pour la façon dont il effectue les mises à jour. Soit en fusionnant directement les changements dans votre dépôt de contenu, soit en ouvrant une pull request pour examen.
|
|
|
|
Pour exiger une revue avant que le workflow mette à jour votre contenu, sélectionnez **Require review** dans le panneau de paramètres.
|
|
|
|
<Note>
|
|
Pour les dépôts GitHub, les mises à jour automatiques nécessitent que l'application GitHub Mintlify dispose des autorisations de bypass sur chaque ruleset ciblant votre branche de déploiement, y compris les rulesets au niveau de l'organisation et au niveau du dépôt. Voir [Configurer l'automerge](/fr/guides/configure-automerge) pour les instructions de configuration.
|
|
|
|
Pour les dépôts GitLab, l'automerge utilise la connexion OAuth GitLab et nécessite au moins le rôle Mainteneur sur chaque projet.
|
|
</Note>
|
|
|
|
<div id="context-repositories">
|
|
### Dépôts de contexte
|
|
</div>
|
|
|
|
Pour les workflows personnalisés et certains workflows prédéfinis, vous pouvez ajouter des dépôts de contexte — des dépôts de code source supplémentaires que l'agent lit lors de l'exécution du workflow. Cela est utile lorsque le prompt de votre workflow fait référence à du code, à des APIs ou à d'autres contenus qui se trouvent en dehors du dépôt de votre projet.
|
|
|
|
Vous pouvez ajouter jusqu'à 10 dépôts de contexte par workflow. Pour chaque dépôt GitHub, l'application GitHub Mintlify doit être installée. Ajoutez des dépôts sur la page [Paramètres de l'application GitHub](https://app.mintlify.com/settings/organization/github-app).
|
|
|
|
<div id="integrations">
|
|
### Intégrations
|
|
</div>
|
|
|
|
Pour les workflows personnalisés et le workflow **Update from code changes**, vous pouvez activer les [intégrations de l'agent](/fr/agent/integrations) connectées afin que l'agent puisse récupérer du contexte depuis des outils comme Slack, Notion ou Linear lors de l'exécution du workflow.
|
|
|
|
Pour activer des intégrations pour un workflow, 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](/fr/agent/integrations) pour plus d'informations sur la connexion des intégrations.
|
|
|
|
<div id="instructions">
|
|
### Instructions
|
|
</div>
|
|
|
|
Ajoutez des instructions optionnelles qui s'ajoutent au prompt de base du workflow à chaque exécution. Utilisez-les pour ajuster le style, le ton ou d'autres comportements propres au projet sans modifier la logique principale du workflow.
|
|
|
|
<div id="target-languages">
|
|
### Langues cibles
|
|
</div>
|
|
|
|
Lorsque vous activez le workflow **traduire le contenu**, sélectionnez une ou plusieurs langues à maintenir synchronisées avec votre contenu source.
|
|
|
|
- Mintlify lit les [langues](/fr/organize/navigation#languages) 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 le workflow.
|
|
- Vous ne pouvez pas sélectionner la langue source comme cible.
|
|
|
|
Vous pouvez ajouter des langues cibles à tout moment en ouvrant les paramètres du workflow et en modifiant le champ **Translate to**.
|
|
|
|
<GitlabWorkflowSetup />
|
|
|
|
<div id="disable-a-workflow">
|
|
## Désactiver un workflow
|
|
</div>
|
|
|
|
1. Accédez à la page [Workflows](https://app.mintlify.com/products/workflows?tab=workflows) dans votre tableau de bord.
|
|
2. Cliquez sur l'interrupteur à côté d'un workflow pour le désactiver.
|
|
|
|
Lorsque vous réactivez un workflow planifié, Mintlify recalcule la prochaine heure d'exécution à partir de l'heure actuelle.
|
|
|
|
<div id="view-run-history">
|
|
## Consulter l'historique des exécutions
|
|
</div>
|
|
|
|
Chaque workflow conserve un journal des exécutions passées, comprenant le statut et un résumé des modifications apportées.
|
|
|
|
1. Accédez à la page [Workflow Runs](https://app.mintlify.com/products/workflows) dans votre tableau de bord.
|
|
2. Utilisez les menus déroulants pour filtrer par workflows spécifiques ou par statut.
|
|
<Frame>
|
|
<img src="/images/workflows/workflow-runs-light.png" alt="Page des exécutions de workflows montrant les filtres par workflow et par statut." className="block dark:hidden" />
|
|
<img src="/images/workflows/workflow-runs-dark.png" alt="Page des exécutions de workflows montrant les filtres par workflow et par statut." className="hidden dark:block" />
|
|
</Frame>
|