Guide des automatisations et des workflows

​

Aperçu

• GitHub Actions - workflows CI/CD pour le test, la validation et les mises à jour automatisées
• n8n Workflows - plateforme d’automatisation externe pour l’obtention de données et les mises à jour du contenu
• Scripts - Outils en ligne de commande pour la génération de contenu, la récupération de données et la maintenance
• Hooks de pré-validation - Validation locale pour s’assurer du respect du guide de style

​

Workflows GitHub Actions

​

Flux de travail actifs

​

Vérification des liens brisés

• Les demandes d’extraits versmain branche

1. Installe l’interface CLI Mintlify
2. Exécutemintlify broken-links pour vérifier tous les liens
3. Sortie d’alerte des publications dans le résumé du workflow (actuellement non bloquante)

​

CI des documents - Suite de qualité du contenu

• Push versmain
• Demandes de tirage versmainoudocs-v2

1. Calcule les fichiers modifiés par rapport à la branche de base de la PR
2. Exécute les vérifications bloquantes portant sur les fichiers modifiés :
   • Guide de style
   • Validation MDX
   • Orthographe
   • Qualité
   • Liens/importations
   • Application des documents de script sur les scripts modifiés
   • Audit strict des liens V2 sur les pages de documentation modifiées
3. Exécution des tests navigateur pour couvrir les routes/exécutions
4. Écrit les résultats dans le résumé de l’étape GitHub

​

Génération du SDK

• Tous les jours à minuit UTC (planifié)
• Envoi manuel depuis l’interface GitHub Actions

1. Utilise l’action de génération du SDK Speakeasy
2. Génère des SDK pour toutes les API configurées
3. Crée des pull requests avec le code généré

1. Allez dans Actions → Génération du SDK
2. Cliquez sur “Exécuter le workflow”
3. Optionnellement définirforce: true pour régénérer même si aucune modification

• SPEAKEASY_API_KEY - Clé API Speakeasy pour la génération du SDK

​

Docs CI - V2 Browser Sweep

• Push vers main
• Pull requests vers main ou docs-v2

1. Démarre le serveur de développement Mintlify
2. Exécute les tests Puppeteer sur toutes les pages
3. Publie les résultats en commentaires de PR
4. Télécharge le rapport détaillé des tests en tant qu’artefact

• Commentaires de PR avec les résultats des tests
• Artifact :v2-page-test-report.json

​

Mise à jour Livepeer Version de la release

• Toutes les 30 minutes (planifié)
• Envoi manuel depuis l’interface GitHub Actions

1. Récupère la dernière version depuis livepeer/go-livepeer le dépôt GitHub
2. Compare avec la version actuelle dans snippets/automations/globals/globals.mdx
3. Met à jour le fichier si une nouvelle version est disponible
4. Valide et pousse les modifications

1. Allez dans Actions → Mettre à jour Livepeer Version de la release
2. Cliquez sur “Exécuter le workflow”

​

Intake de problème Discord (Phase 1)

• repository_dispatch avec type discord-issue-intake

1. Valide le schéma de charge utile de diffusion et les champs requis pour le modèle docs_page_issue
2. Rejette le contenu uniquement avec des espaces réservés ou sensible à la sécurité
3. Impose l’idempotence en utilisant correlation_id marqueur dans le corps de l’incident
4. Crée un incident avec des titres alignés sur le modèle et des étiquettes de base
5. Mappe les étiquettes dynamiques (area:*, classification:*, priority:*, kind:*) à issue-auto-label.yml

• Prise en charge de schema_version 1.0.0 et 1.1.0
• 1.1.0 ajoute les fields.classification requis pour docs_page_issue
• 1.0.0les charges utiles restent valides pour la compatibilité vers l’arrière et provoqueront des problèmes sans une Classificationsection (l’indexeur les affichera comme non classifiées jusqu’à ce qu’elles soient triées)
• Si vous modifiez les noms de champs ou les titres de section dans les formulaires de problème, mettez à jour les deux :
  • .github/workflows/discord-issue-intake.yml(validation des charges utiles + en-têtes de corps générés)
  • .github/workflows/issue-auto-label.yml(analyse des sections / correspondance des étiquettes)
• Gardez les en-têtes du corps des problèmes exacts (par exemple ### Classification, ### Priority) car l’analyse automatique des étiquettes est basée sur les titres

1. Ajouter un support pour la nouvelle version du schéma dans .github/workflows/discord-issue-intake.yml
2. Conserver la version précédente du schéma acceptée jusqu’à ce que tous les expéditeurs de diffusion soient mis à niveau
3. Mettre à jour snippets/automations/scripts/n8n/Discord-Issue-Intake.json pour émettre la nouvelle version et les champs
4. Vérifier qu’une diffusion de test crée les en-têtes et étiquettes attendus

• Aucun (utilise le jeton d’appelant repository-dispatch et GitHub Actions GITHUB_TOKEN)

• snippets/automations/scripts/n8n/Discord-Issue-Intake.json
• snippets/assets/scripts/n8n/README-discord-issue-intake-workflow.md
• .github/workflows/issue-auto-label.yml

​

Étiquette automatique

• area:*
• classification:* (gravité/impact)
• priority:* (planification du mainteneur)
• kind:* (sous-type de page de documentation)
• scope:*

• L’analyse est basée sur les titres markdown exacts dans le corps des problèmes (par exemple ### Area, ### Classification, ### Priority)
• Si un titre est renommé dans un modèle de problème, mettez à jourgetSection(...) l’utilisation et les listes de sections obligatoires dans ce workflow
• La compatibilité avec les problèmes anciens est intentionnelle :
  • Classification n’est traité comme obligatoire que lorsqu’un corps de problème contient déjà une### Classification section
  • Cela empêche les anciens problèmes d’être automatiquement étiquetés status: needs-infolors des modifications de ré-triage
• Le workflow ignore l’index de niveau supérieur des documents v2 en vérifiant le marqueur caché :
  • <!-- docs-v2-issue-indexer -->
  • Ne supprimez ou ne renommez pas ce marqueur sans mettre à jour à la fois ce workflow et le workflow de l’indexeur

1. Ouvrez un problème de test à partir de chaque modèle affecté (ou modifiez le corps d’un problème de test existant)
2. Confirmer classification:* et priority:* étiquettes sont toutes appliquées
3. Changer la classification dans le corps du problème et confirmer que l’ancienne classification:* étiquette est supprimée
4. Confirmer que l’incident docs-v2 n’est pas automatiquement étiqueté avec status: needs-triage

​

Indexeur de problèmes de Docs v2

• issuesévénements : ouvrir/modifier/étiqueter/détacher/reouvrir/fermer
• planifié toutes les 6 heures
• envoi manuel

1. Trouve l’incident indexé par le marqueur caché dans le corps de l’incident (<!-- docs-v2-issue-indexer -->）
2. Crée l’incident d’index s’il n’existe pas
3. Interroge tous lesdocs-v2 incidents ouverts et récemment fermésdocs-v2 incidents (fenêtre par défaut de 30 jours)
4. Génère des comptes résumés + des tableaux de décomposition + des tableaux d’incidents
5. Met à jour le même corps d’incident en place uniquement si le contenu a changé

• Le marqueur caché est la source de vérité pour localiser le problème d’index. Gardez-le stable sauf si vous mettez à jour les deux :
  • .github/workflows/docs-v2-issue-indexer.yml
  • .github/workflows/issue-auto-label.yml
• La fenêtre récemment fermée est contrôlée par RECENTLY_CLOSED_DAYS dans le script de workflow
• Le workflow exclut intentionnellement le problème d’index lui-même des comptages/tableaux, même s’il a le docs-v2 étiquette
• Le workflow ignore les boucles de déclenchement auto en sortant prématurément si le corps de l’incident déclencheur contient déjà le marqueur d’index
• Si le corps de l’incident généré semble obsolète, utilisezActions → Docs v2 Issue Indexer → Exécuter le workflow

• Problèmes d’index en double :
  • Assurez-vous qu’un seul incident contient le marqueur<!-- docs-v2-issue-indexer -->
  • Supprimez le marqueur des doublons, puis exécutez le workflow manuellement
• Étiquettes manquantes dans les analyses :
  • Vérifiez.github/workflows/issue-auto-label.yml les préfixes gérés et l’analyse des étiquettes
  • Vérifiez que les titres du corps du problème correspondent toujours aux attentes du parseur
• Problèmes ouverts non classés inattendus :
  • Ce sont généralement des problèmes hérités (pré-classification) ou des problèmes créés à partir d’un schéma d’entrée Discord plus ancien1.0.0

​

Flux de récupération des données (GitHub Actions & n8n disponibles)

​

Mettre à jour les données du forum

• Tous les jours à minuit UTC (planifié)
• Envoi manuel

1. Exécute .github/scripts/fetch-forum-data.js
2. Mises à jour snippets/automations/forum/forumData.jsx
3. Validation et envoi si des modifications sont détectées

• DOCS_V2 - Jeton GitHub pour l’accès au dépôt de documentation
• GHOST_CONTENT_API_KEY - Clé d’API de contenu Ghost utilisée par .github/scripts/fetch-ghost-blog-data.js

​

Mettre à jour les données du blog Ghost

• Tous les jours à minuit UTC (planifié)
• Affectation manuelle

1. Exécute .github/scripts/fetch-ghost-blog-data.js
2. Met à jour snippets/automations/blog/ghostBlogData.jsx
3. Valide et pousse si des modifications sont détectées

• DOCS_V2 - Jeton GitHub pour l’accès au dépôt de documentation

​

Mettre à jour les données YouTube

• Hebdomadaire le dimanche à minuit UTC (planifié)
• Envoi manuel

1. Exécute.github/scripts/fetch-youtube-data.js
2. Filtre les Shorts (≤60 secondes)
3. Met à joursnippets/automations/youtube/youtubeData.jsx
4. Valide et pousse si des modifications sont détectées

• YOUTUBE_API_KEY - Clé de l’API YouTube Data v3

​

Flux d’automatisation n8n

​

Workflows n8n actifs

​

Événements Luma vers Mintlify

1. Récupère les données iCal de l’API Luma
2. Analyse les événements (à venir et passés)
3. Génère un fichier de données JSX
4. Valide sur GitHub surdocs-v2 branche

1. Importer le fichier JSON dans une instance n8n
2. Configurer les identifiants GitHub
3. Définir l’ID du calendrier Luma
4. Activer le workflow

• Jeton d’API GitHub avec accès en écriture
• ID du calendrier Luma :cal-X93qV3PuUH0wq0f

​

Pipeline du projet de démonstration

1. Surveille les feuilles Google pour les nouvelles soumissions de projets
2. Valide les données de la soumission
3. Envoie des notifications Discord pour l’approbation
4. Télécharge les fichiers multimédias depuis Google Drive
5. Met à jour snippets/automations/showcase/showcaseData.jsxlorsqu’apprové
6. Envoie des notifications aux soumissionnaires

1. Importer le fichier JSON dans une instance n8n
2. Configurer les identifiants Google Sheets, Discord et GitHub
3. Configurez un formulaire Google pour les soumissions
4. Activer le workflow

• OAuth2 de Google Sheets
• API du bot Discord
• Jeton d’API GitHub
• OAuth2 de Google Drive

• Formulaire Google pour les soumissions de projet
• Feuille Google pour le suivi des soumissions
• Serveur Discord pour le workflow d’approbation

​

Prise en charge des problèmes Discord (Phase 1)

1. Vérifie les signatures des requêtes Discord
2. Applique la liste autorisée des canaux et les limites de fréquence par utilisateur
3. Collecte les champs longs via une fenêtre contextuelle
4. Affiche un aperçu avec des étiquettes déduites + boutons Confirmer/Annuler
5. Envoie repository_dispatch à GitHub (discord-issue-intake)
6. Interroge la création de l’issue et envoie un message de suivi avec l’URL de l’issue

• snippets/assets/scripts/n8n/README-discord-issue-intake-workflow.md

• DISCORD_PUBLIC_KEY
• ALLOWED_CHANNEL_IDS
• GITHUB_DISPATCH_TOKEN
• GITHUB_OWNER
• GITHUB_REPO
• GITHUB_DISPATCH_EVENT_TYPE
• SECURITY_REPORT_URL
• RATE_LIMIT_WINDOW_SEC
• RATE_LIMIT_MAX
• DISCORD_ISSUE_SCHEMA_VERSION
• GITHUB_POLL_ATTEMPTS
• GITHUB_POLL_DELAY_MS

​

Flux de travail n8n supplémentaires (Alternative à GitHub Actions)

• Ghost-to-Mintlify.json - Récupère les articles de blog Ghost (alternative à update-ghost-blog-data.yml)
• Forum-To-Mintlify-Latest-Topics.json - Récupère les sujets du forum (alternative à update-forum-data.yml)
• YouTube-To-Mintlify.json - Récupère les vidéos YouTube (alternative à update-youtube-data.yml)
• Discord_Announce_to_Mintlify.json - Récupère les annonces Discord (n8n uniquement - pas d’équivalent GitHub Action)
• Discord-Issue-Intake.json - Relais d’entrée de problème Discord (associé à).github/workflows/discord-issue-intake.yml)

​

Flux de travail utiles

​

Convertisseur MP4 en GIF

1. Accepte une URL vidéo ou un chemin local
2. Télécharge la vidéo (si une URL est fournie)
3. Convertit en GIF à l’aide de FFmpeg
4. Renvoie le fichier GIF ou le chemin du fichier

1. Importer le fichier JSON dans une instance n8n
2. Configurer l’URL du webhook
3. Envoyer une requête POST avec l’URL de la vidéo ou le chemin local
4. Receiver GIF en réponse

• video_url (facultatif) - URL du fichier vidéo
• local_path (facultatif) - Chemin d’accès au fichier local
• fps (par défaut : 10) - Images par seconde
• width (par défaut : 480) - Largeur de sortie
• start_time (par défaut : “0”) - Heure de départ dans la vidéo
• duration (facultatif) - Durée à convertir
• optimize (par défaut : true) - Utiliser l’optimisation de palette
• output_path (facultatif) - Chemin du fichier de sortie

​

Scripts

​

Scripts de génération de contenu

​

Générer les métadonnées SEO

# Dry run (preview changes)
node tools/scripts/snippets/generate-seo.js --dry-run

# Process all files
node tools/scripts/snippets/generate-seo.js

# Process single file
node tools/scripts/snippets/generate-seo.js --file=v2/home/mission-control.mdx

1. Analyse tous les fichiers MDX dans v2/pages/
2. Génère keywords à partir du chemin du fichier, du titre et de la description
3. Ajoute og:image en utilisant des images de prévisualisation sociales spécifiques au domaine ou par défaut
4. Préserve les métadonnées SEO existantes (ne remplace pas si elles sont déjà présentes)

• Après la création de nouvelles pages de documentation
• Lors de la mise à jour des titres ou des descriptions de page
• Avant le déploiement pour améliorer le SEO

​

Générer la documentation de l’API

./tools/scripts/snippets/generate-api-docs.sh <openapi-spec> <output-dir> <api-name> [github-repo-url]

./tools/scripts/snippets/generate-api-docs.sh \
  ai/worker/api/openapi.yaml \
  v2/pages/04_gateways/api-reference/AI-API \
  "AI API" \
  "https://github.com/livepeer/ai-worker"

1. Lit un spécimen OpenAPI (YAML ou JSON)
2. Crée unepage de destination avec des CardGroups liés à chaque point de terminaison (regroupés par balises)
3. Créepages MDX individuelles pour chaque point de terminaison avec openapi: METHOD /path frontmatter
4. Génère un fragment de navigation docs.json prêt à copier-coller

output-dir/
├── ai-api.mdx           # Landing page with Base URLs + CardGroups
├── text-to-image.mdx    # openapi: post /text-to-image
├── image-to-image.mdx   # openapi: post /image-to-image
└── ...

​

Mettre à jour la bibliothèque de composants

./tools/scripts/snippets/update-component-library.sh

1. Analyse snippets/components/ structure de répertoire
2. Génère un<Tree> composant avec tous les dossiers et fichiers
3. Met à joursnippets/snippetsWiki/componentLibrary/index.mdx

• Après l’ajout de nouveaux composants à snippets/components/
• Après la réorganisation de la structure du dossier des composants
• Après le renommage ou la suppression des fichiers de composant

​

Scripts de récupération des données

​

Récupérer les spécifications OpenAPI

./tools/scripts/snippets/fetch-openapi-specs.sh

1. Télécharge les spécifications OpenAPI depuis des dépôts externes
2. Enregistre dansai/worker/api/

• openapi.yaml - Spécification de l’API AI Runner
• gateway.openapi.yaml - Spécification de l’API AI Gateway

​

Récupérer la documentation externe

./tools/scripts/snippets/fetch-external-docs.sh

1. Télécharge la documentation depuis des dépôts externes
2. Nettoie le contenu pour la compatibilité MDX
3. Sauvegarde danssnippets/external/

• wiki-readme.mdx - livepeer/wiki README
• awesome-livepeer-readme.mdx - livepeer/awesome-livepeer README
• whitepaper.mdx - Livepeer Whitepaper
• gwid-readme.mdx - videoDAC/livepeer-gateway README
• box-additional-config.mdx - configuration de la boîte go-livepeer

• Échapper les accolades pour MDX
• Supprimer les commentaires HTML
• Convertir les balises HTML en équivalents Markdown

​

Récupérer les échanges LPT

./tools/scripts/snippets/fetch-lpt-exchanges.sh

1. Récupère des données en temps réel de l’API CoinGecko pour le jeton Livepeer
2. Génère un tableau stylisé des échanges CEX avec le volume et les scores de confiance
3. Ajoute les informations DEX et les adresses de contrat
4. Mises à jour v2/pages/06_delegators/token-resources/lpt-exchanges.mdx

• Périodiquement pour mettre à jour les listes d’échanges
• Avant les grandes releases pour s’assurer que les données sont à jour

​

Scripts de test

​

Script de balayage du navigateur V2 (test:v2-pages)

cd tools && npm run test:v2-pages
# or
node tools/scripts/test-v2-pages.js

1. Extrait toutes les pages v2 de docs.json
2. Démarre le serveur de développement Mintlify (si ce n’est pas déjà en cours)
3. Teste chaque page avec Puppeteer
4. Signale les erreurs de la console, les erreurs de page et les échecs de requête
5. Génère un rapport JSON détaillé

• npx mintlify devdoit être en cours d’exécution (ou définir la variable d’environnement)MINT_BASE_URL)
• Puppeteer installé (npm install)

• Sortie de la console avec le statut pass/échec
• v2-page-test-report.json - Résultats détaillés des tests

• MINT_BASE_URL - URL de base pour le serveur de développement Mintlify (par défaut : http://localhost:3000)

​

Scripts GitHub (utilisés par les workflows)

• .github/scripts/fetch-forum-data.js - Récupère les données du forum (utilisé par update-forum-data.yml)
• .github/scripts/fetch-ghost-blog-data.js - Récupère les données du blog Ghost (utilisé par update-ghost-blog-data.yml)
• .github/scripts/fetch-youtube-data.js - Récupère les données de YouTube (utilisé par update-youtube-data.yml)

​

Hooks de pré-validation

​

Installation

./.githooks/install.sh

cp .githooks/pre-commit .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit

​

Ce qui est vérifié

​

Conformité au guide de style

• ❌ Utilisation de ThemeData - Blocs dépréciésThemeData imports from themeStyles.jsx
• ❌ Couleurs codées en dur - Avertit sur les couleurs hexadécimales qui devraient utiliser les propriétés CSS personnalisées
• ⚠️ Imports relatifs - Avertit sur les chemins relatifs (il faut utiliser des chemins absolus à partir de la racine)
• ⚠️ @mintlify/components imports - Avertit sur les imports inutiles (les composants sont globaux)
• ⚠️ imports de hooks React - Avertit sur les importations React inutiles (les hooks sont globaux)

​

Scripts de vérification

• ✅ Syntaxe MDX - Valide le frontmatter et la structure MDX basique
• ✅ Syntaxe JSON - Valide que les fichiers JSON sont parseables
• ✅ Syntaxe des scripts shell - Valide les scripts shell avec bash -n
• ✅ la syntaxe JavaScript - Valide les fichiers JS avec node --check
• ✅ Mintlify config - Valide docs.json/mint.json syntaxe
• ✅ ** Chemins d’importation** - Assure que les imports de morceaux utilisent des chemins absolus
• ✅ Validation du navigateur - Teste les fichiers MDX dans un navigateur sans interface graphique (si “npx mintlify dev est en cours d’exécution)

​

Ce qui se passe en cas de violation

1. Le commit est bloqué
2. Vous recevez un message d’erreur détaillé listant toutes les violations
3. Vous devez corriger les violations avant de valider à nouveau

​

Validation du navigateur

• Erreurs de runtime dans les composants
• Imports ratés
• Erreurs de console
• Échecs de rendu

​

Bypass des hooks (non recommandé)

git commit -m "Update .allowlist" --trailer "allowlist-edit=true"

git commit -m "Remove obsolete files" --trailer "allow-deletions=true"

# Bypass pre-commit hook
git commit --no-verify -m "message"

• Violent la conformité au guide de style
• Peut introduire des erreurs qui cassent la construction
• Rendre la revue de code plus difficile
• Peut causer des problèmes pour d’autres développeurs

​

Exécution des automatisations

​

Exécution manuelle

​

GitHub Actions

1. Aller àActionsonglet dans le dépôt GitHub
2. Sélectionner le workflow que vous souhaitez exécuter
3. Cliquez sur **“Exécuter le workflow”**bouton
4. Sélectionnez la branche et tous les paramètres requis
5. Cliquez sur “Exécuter le workflow” pour commencer

​

Scripts

# From repository root
node tools/scripts/snippets/generate-seo.js
./tools/scripts/snippets/fetch-lpt-exchanges.sh
npm run test:v2-pages

​

Workflows n8n

1. Importer un fichier JSON dans une instance n8n
2. Configurer les identifiants et les paramètres
3. Activer le workflow
4. Surveiller les exécutions dans le tableau de bord n8n

​

Exécution planifiée

• GitHub Actions - Utiliser schedule déclencheur avec la syntaxe cron
• Workflows n8n - Utiliser le nœud déclencheur de planification avec un intervalle ou un cron

​

Surveillance

• GitHub Actions - Vérifier l’onglet Actions pour les exécutions de workflow et les journaux
• n8n - Vérifiez le tableau de bord n8n pour l’historique d’exécution
• Scripts - Vérifiez la sortie du terminal et les fichiers générés

​

Dépannage

​

GitHub Actions ne s’exécute pas

1. Vérifiez la syntaxe du fichier de workflow (le YAML doit être valide)
2. Vérifiez que les conditions de déclenchement correspondent à votre branche/événement
3. Consultez l’onglet Actions pour les messages d’erreur
4. Assurez-vous que le fichier de workflow est dans .github/workflows/ répertoire

​

Scripts échouant

1. Vérifiez que le script a les permissions d’exécution : chmod +x script.sh
2. Vérifier que la version de Node.js correspond aux exigences du script
3. Vérifier les dépendances manquantes : npm install
4. Examiner la documentation du script pour les prérequis
5. Exécuter avec un mode détaillé si disponible

​

Le hook de pré-validation ne s’exécute pas

1. Vérifier que le hook est installé : ls -la .git/hooks/pre-commit
2. Vérifier que le hook est exécutable : chmod +x .git/hooks/pre-commit
3. Réinstaller : ./.githooks/install.sh
4. Vérifier la présence de .git/hooks/pre-commit le fichier existe

​

Problèmes de workflow n8n

1. Vérifiez que le workflow est actif dans le tableau de bord n8n
2. Vérifier que les identifiants sont configurés correctement
3. Vérifier les journaux d’exécution dans n8n
4. Vérifier que le jeton GitHub a des autorisations d’écriture
5. Vérifier que le nom de la branche correspond à la configuration du workflow

​

Secrets/Clés manquants

1. Accédez au dépôtParamètres → Secrets et variables → Actions
2. Ajoutez les secrets requis (par exemple, YOUTUBE_API_KEY, SPEAKEASY_API_KEY)
3. Vérifier que les noms des secrets correspondent exactement au fichier de workflow
4. Pour n8n, configurer les identifiants dans le tableau de bord n8n

​

Bonnes pratiques

​

Quand utiliser quoi

• ✅ Récupération de données simple (appels d’API, mises à jour de fichiers)
• ✅ Opérations natives du dépôt (validations, PRs, vérifications)
• ✅ Workflows CI/CD (tests, validation)
• ✅ Tâches planifiées qui n’ont besoin que d’un accès GitHub
• ✅ Lorsque vous voulez tout dans le dépôt

• ✅ Workflows multi-étapes complexes
• ✅ Intégrations de services externes (Discord, Google Sheets, Google Forms)
• ✅ Workflows d’approbation avec notifications
• ✅ Workflows nécessitant une interaction utilisateur
• ✅ Lorsque vous avez besoin d’une gestion visuelle du workflow

• ✅ Tâches ponctuelles et génération de contenu
• ✅ Développement et tests locaux
• ✅ Mises à jour manuelles des données

• ✅ Enforcer la qualité du code et la conformité au guide de style
• ✅ Détecter les erreurs avant le commit

​

Maintenir les automatisations à jour

1. Examiner les rapports d’audit - Vérifiez docs/PLAN/reports/ pour le statut d’automatisation
2. Testez avant de déployer - Exécutez des scripts localement avant de valider
3. Surveillez les exécutions de workflow - Vérifiez régulièrement les tableaux de bord GitHub Actions et n8n
4. Mettre à jour la documentation - Gardez ce guide à jour lorsque les automatisations changent

​

Considérations sur la sécurité

• Ne jamais valider des secrets - Utilisez GitHub Secrets ou les identifiants de n8n
• Examiner les validations automatiques - Faites attention aux scripts qui valident automatiquement
• Limitez les autorisations des jetons - Utilisez un accès à faible privilège pour les jetons API
• Effectuez des audits régulièrement - Revoyez périodiquement l’accès et les autorisations d’automatisation

​

Documentation associée

• Guide de style - Conventions de style et pièges Mintlify
• Bibliothèque de composants - Composants disponibles et utilisation
• Documentation des hooks Git - Documentation complète des hooks de pré-validation
• README des scripts - Documentation détaillée des scripts
• README des automatisations - Aperçu des automatisations
• Rapport d’audit - Audit complet des automatisations

​

Obtenir de l’aide

1. Consultez ce guide pour les étapes de dépannage
2. Examinez le rapport d’audit pour les problèmes connus
3. Consultez la documentation du workflow/script
4. Examinez les journaux d’exécution (GitHub Actions ou n8n)
5. Demandez dans le dépôt ou les canaux de la communauté