Brouillons de PR automatiques
Les brouillons de PR automatiques maintiennent votre documentation synchronisée avec votre produit. Lorsqu'une pull request fusionnée modifie un comportement orienté client, Fern le détecte et prépare automatiquement un brouillon de mise à jour de la documentation.
Cette fonctionnalité connecte votre intégration GitHub à Fern, de sorte que les mises à jour de la documentation s'effectuent sans surveillance manuelle. Vous continuez à examiner et à approuver chaque brouillon avant sa mise en ligne.
Comment ça marche
Lorsque vous activez les brouillons de PR automatiques, Fern surveille les pull requests fusionnées dans votre dépôt GitHub connecté. Si une fusion modifie un élément que vos clients doivent connaître, Fern crée un brouillon d'article ou une mise à jour.
Le brouillon apparaît sur 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 et publiez quand vous êtes prêt. Fern ne publie jamais automatiquement.
Prérequis
Intégration GitHub connectée - Fern a besoin d'accéder à votre dépôt pour surveiller les pull requests. Si vous n'avez pas encore connecté GitHub, set up the integration d'abord.
Activer les brouillons de PR automatiques
Go to Settings
Ouvrez les 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 programmés.
Enable the toggle
Activez l'option Automatic PR drafts. Le paramètre est enregistré immédiatement et vous verrez un message de confirmation.
Une fois activé, Fern commence à surveiller les pull requests fusionnées pour détecter les changements orientés client.
Ce qui déclenche un brouillon
Fern prépare un brouillon de mise à jour quand :
Une pull request est fusionnée dans votre dépôt GitHub connecté
La fusion inclut des changements dans le comportement orienté client (flux d'interface utilisateur, points de terminaison d'API, comportement des fonctionnalités, messages d'erreur ou options de configuration)
Fern analyse le diff pour déterminer si la documentation nécessite une mise à jour. Si le changement est interne ou n'affecte pas les clients, Fern marque le fil de discussion comme « Aucune modification de documentation nécessaire » et ne créera pas de brouillon.
Vous pouvez voir les exécutions pour lesquelles Fern n'a pas créé de brouillon en filtrant par Automatisations sur la page Fern.
Examiner vos brouillons
Lorsque Fern crée un brouillon, il apparaît sur votre page Fern sous forme de fil de discussion avec une icône de pull request. Le fil de discussion affiche :
Le titre de la PR et les métadonnées
Un résumé des changements
Le statut du brouillon (en cours, prêt à être examiné ou erreur)
Cliquez sur le fil de discussion pour ouvrir le panneau de détails. Lorsque le brouillon est prêt, cliquez sur Réviser et modifier les changements pour voir ce que Fern a écrit. Modifiez le brouillon directement, demandez des révisions en envoyant un message à Fern dans le fil de discussion, ou publiez lorsque vous êtes satisfait.
Vous pouvez filtrer la liste des fils de discussion Fern en sélectionnant Has drafts pour voir uniquement les fils avec des mises à jour de brouillon prêtes pour révision.
Vous contrôlez la publication
Fern prépare les mises à jour sous forme de brouillons 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 connexes
Comment Fern crée des articles - le flux de travail de rédaction et de révision