Lorsque les développeurs encomment de nouveau code ou des mises à jour dans un dépôt GitHub, les modifications correspondantes doivent souvent être reflétées dans votre base de connaissances. Créer ou mettre à jour manuellement des articles Document360 pour chaque commit est long et sujet aux erreurs. En connectant GitHub et Document360 via Zapier, vous pouvez automatiser cela : chaque fois qu’un événement spécifié survient dans un dépôt GitHub, Zapier crée automatiquement un article correspondant dans votre base de connaissances Document360.
Quand utiliser cette intégration
- Votre équipe d’ingénierie suit une approche docs-as-code et souhaite que chaque commit GitHub soit envoyé dans un dépôt spécifique afin de générer automatiquement un brouillon d’article dans Document360 pour la relecture.
- Vous maintenez un journal des modifications ou une base de connaissances de notes de publication dans Document360 et vous souhaitez que de nouveaux commits ou publications sur GitHub déclenchent automatiquement la création d’articles.
- Votre flux de travail de développement inclut des mises à jour de documentation en plus des modifications de code, et vous voulez vous assurer que les articles de la base de connaissances soient créés en synchronisation sans étape manuelle.
Avant que tu commences
- Vous devez être connecté à votre compte Zapier.
- Vous devez avoir un compte GitHub avec accès au dépôt que vous souhaitez surveiller.
- Vous devez avoir votre jeton API Document360 prêt. Pour en générer un, naviguez dans Connexions > Extensions, localisez la tuile Zapier, puis cliquez sur Connecter pour copier le jeton.
Comment configurer le Zap
Étape 1 — Créer un nouveau Zap
- Connectez-vous à votre compte Zapier.
- Dans le menu de navigation de gauche, cliquez sur Créer puis sélectionnez Zaps.
- Un nouveau Zap est créé avec un flux de Déclenchement et d’Action .
Étape 2 — Connecter GitHub comme déclencheur
- Dans le champ Trigger , choisissez GitHub.
- Dans le champ Déclenchement d’événement, sélectionnez l’événement qui devrait déclencher la Zap.
NOTE
Pour changer l’application de déclenchement plus tard, cliquez sur Modifier dans le champ Déclencheur.
- Cliquez sur le champ Compte — un panneau de connexion apparaît.
- Saisissez vos identifiants GitHub et cliquez sur Autoriser Zapier.
- Choisissez le dépôt souhaité et cliquez sur Continuer. Zapier effectue un test pour confirmer que le déclencheur est correctement configuré.
Étape 3 — Connecter Document360 comme action
- Dans le champ Action , choisissez Document360.
- Dans le panneau Configuration, sélectionnez l’événement souhaité dans le champ Événement .
- Cliquez sur le champ Compte — un panneau de connexion apparaît.
- Saisissez vos identifiants de connexion et cliquez sur Autoriser.
Pour générer le jeton API à partir de Document360 :
- Naviguez dans Connexions > Extensions dans la barre de navigation de gauche du portail de la base de connaissances.
- Sur la tuile d’extension Zapier , cliquez sur Connecter.
- Cliquez sur l’icône Copier pour copier le jeton.
- Retournez sur le panneau Zapier et collez le jeton API dans le champ.
- Cliquez sur Oui, continuer à Document360.
- Vous pouvez trouver le projet Document360 lié sur la page du compte Connect Document360 . Pour utiliser un autre compte plus tard, cliquez sur Changer.
- Cliquez sur Continuer.
Étape 4 — Cartographier les champs
- Mapper les champs de GitHub vers Document360 :
| Terrain | Description |
|---|---|
| Titre | Par défaut, Nouveau Commit dans GitHub est sélectionné. D’autres options sont disponibles selon vos besoins. |
| Contenu | Par défaut, Message de validation est sélectionné. D’autres options sont disponibles selon vos besoins. |
| Version | Choisissez l’espace de travail dans votre projet Document360 où l’article doit être créé. |
| Langue | Choisissez la langue dans l’espace de travail sélectionné. |
| Catégorie | Sélectionnez la catégorie où l’article sera créé. |
| Publier | Mettez-vous sur Vrai pour publier l’article immédiatement. Réglez sur Faux pour sauvegarder comme brouillon. |
NOTE
Le bouton Continuer n’est activé qu’après que tous les champs requis ont été mappés.
- Cliquez sur Continuer.
Étape 5 — Tester et publier le Zap
- Dans la section test, cliquez sur Envoyer le test.
- Si vous réussissez, vous recevrez le message de Test Article envoyé ! Vérifiez votre compte Document360 pour le consulter.
- Dans votre portail Document360, vous trouverez un nouvel article intitulé « Nouveau commit sur GitHub » dans la catégorie que vous avez sélectionnée.
- Retournez dans le panneau de configuration de Zapier et cliquez sur Suivant, puis sur Publier.
- Vous verrez un message de réussite : votre Zap est activé. Cliquez sur Gérer votre Zap pour accéder à la page d’aperçu du Zap.
Aperçu de Zap
Une fois activé, vous pouvez visualiser et gérer le Zap depuis le tableau de bord Zapier. La page d’aperçu montre le déclencheur, l’action et l’historique de la partie pour le Zap.
Comment supprimer un Zap
- Accédez au tableau de bord de Zapier. Une liste de tous les Zaps existants est affichée sur la page d’aperçu.
- Cliquez sur l’icône des actions de Zap () à droite du Zap que vous souhaitez retirer et cliquez sur Supprimer. Le Zap est supprimé définitivement.
Meilleures pratiques
- Réglez le champ Publication sur Faux lors du mappage des champs afin que les articles déclenchés par GitHub apparaissent dans Document360 en tant que brouillons. Cela donne à votre équipe de documentation l’occasion de revoir, formater et enrichir le contenu avant sa mise en ligne — car les messages de commit bruts sont rarement prêts à être publiés tels quels.
- Utilisez une catégorie dédiée dans Document360 pour les articles déclenchés par GitHub, comme une catégorie « Changelog » ou « Dev updates ». Cela permet de séparer le contenu généré automatiquement des articles faits main et facilite la relecture et la promotion.
- Choisissez un événement déclencheur spécifique qui correspond à votre flux de travail — par exemple, un push vers une branche de release plutôt que chaque commit — afin d’éviter de générer des articles pour chaque changement de code de routine qui ne nécessite pas une entrée dans la base de connaissances.