Brouillons de PR automatiques
Les brouillons de PR automatiques maintiennent votre documentation en phase avec votre produit. Lorsqu’une pull request fusionnée modifie un comportement visible par les clients, Fern le détecte et rédige automatiquement une mise à jour de la documentation.
Cette fonctionnalité relie votre intégration GitHub à Fern, afin que les mises à jour de la documentation se fassent sans surveillance manuelle. Vous continuez à examiner et approuver chaque brouillon avant sa mise en ligne.
Fonctionnement
Lorsque vous activez les brouillons de PR automatiques, Fern surveille les pull requests fusionnées dans vos dépôts GitHub connectés. Si une fusion modifie quelque chose que vos clients doivent connaître, Fern crée un brouillon d’article ou de mise à jour.
Le brouillon apparaît dans votre page Fern sous forme de fil de discussion avec une icône de pull request. Vous l’examinez, effectuez des modifications si nécessaire, puis le publiez quand tout est prêt. Fern ne publie jamais automatiquement.
Si vous avez plusieurs dépôts connectés, Fern peut limiter son analyse au dépôt où la fusion a eu lieu. Pour les changements spécifiques à une branche, Fern peut aussi parcourir la branche précise afin de comprendre ce qui a changé avant de rédiger la mise à jour.
Prérequis
Intégration GitHub connectée - Fern a besoin d’accéder à vos dépôts pour surveiller les pull requests. Si vous n’avez pas encore connecté GitHub, configurez l’intégration d’abord.
Activer les brouillons de PR automatiques
Go to Settings
Ouvrez Paramètres depuis la barre latérale de votre tableau de bord Ferndesk.
Open Automations
Cliquez sur Automatisations dans la barre latérale des paramètres. Cette page affiche à la fois les brouillons de PR automatiques et les paramètres d’audit planifiés.
Enable the toggle
Activez Brouillons de PR automatiques. Le paramètre est enregistré immédiatement et vous verrez une notification de confirmation.
Une fois activé, Fern commence à surveiller les pull requests fusionnées pour détecter les changements visibles par les clients.
Déclenchement d’un brouillon
Fern rédige une mise à jour lorsque :
Une pull request est fusionnée dans l’un de vos dépôts GitHub connectés
La fusion inclut des changements dans le comportement visible par les clients (parcours UI, endpoints API, comportement des fonctionnalités, messages d’erreur ou options de configuration)
Fern analyse le diff pour déterminer si la documentation doit être mise à jour. Si le changement est interne ou n’a pas d’impact pour les clients, Fern marque le fil comme « Aucune modification de la documentation nécessaire » et ne crée pas de brouillon.
Vous pouvez voir les exécutions où Fern n’a pas créé de brouillons en filtrant par Automatisations sur la page Fern.
Relire vos brouillons
Lorsque Fern crée un brouillon, il apparaît dans votre page Fern sous forme de fil de discussion avec une icône de pull request. Le fil affiche :
Le titre et les métadonnées de la PR
Un résumé de ce qui a changé
Le statut du brouillon (en cours, prêt à être relu ou erreur)
Cliquez sur le fil pour ouvrir le panneau de détails. Lorsque le brouillon est prêt, cliquez sur Relire et modifier les changements pour voir ce que Fern a rédigé. Modifiez le brouillon directement, demandez des révisions en envoyant un message à Fern dans le fil, ou publiez-le quand tout vous convient.
Vous pouvez filtrer la liste des fils Fern en sélectionnant A des brouillons pour n’afficher que les fils dont les mises à jour en brouillon sont prêtes à être relues.
Vous contrôlez la publication
Fern rédige des mises à jour, mais ne les publie jamais automatiquement. Chaque brouillon nécessite votre examen et votre approbation avant d’apparaître dans votre centre d’aide. Cela vous donne un contrôle total sur ce qui est mis en ligne tout en supprimant le travail manuel de surveillance des pull requests.
Articles associés
Comment Fern crée des articles - le flux de rédaction et de relecture
Intégration GitHub - comment connecter et gérer les dépôts