Brouillons automatiques de PR
Activez Brouillons automatiques de PR dans Paramètres > Automatisations pour que Fern prépare une mise à jour de la documentation lorsqu’une pull request fusionnée modifie un comportement visible par les clients. Vous examinez et publiez toujours chaque brouillon ; Fern ne publie jamais automatiquement.
Avant de commencer
Connectez l’intégration GitHub afin que Fern puisse surveiller les pull requests de vos dépôts.
Activer les brouillons automatiques de PR
Ouvrez Paramètres depuis la barre latérale du tableau de bord.
Sélectionnez Automatisations. La page contient Brouillons automatiques de PR et Audits planifiés.
Activez Brouillons automatiques de PR. Le paramètre est enregistré immédiatement.
Lorsque le bouton est activé, Sensibilité et Instructions pour les brouillons de PR s’affichent en dessous.
Choisir la sensibilité
Utilisez Sensibilité pour contrôler la facilité avec laquelle Fern crée un brouillon à partir d’une pull request fusionnée. Choisissez une option :
Stricte : uniquement les changements évidents : Fern prépare un brouillon uniquement lorsque la nécessité d’une mise à jour de la documentation est particulièrement claire.
Équilibrée : option par défaut. Fern prépare un brouillon pour les changements clairement visibles par les clients et ignore les changements moins évidents.
Impatiente : davantage de brouillons : Fern prépare des brouillons pour un éventail plus large de changements visibles par les clients.
La modification du sélecteur est enregistrée immédiatement.
La sensibilité ne garantit pas la création d’un brouillon pour chaque changement visible du produit. Fern détermine toujours si la fusion nécessite une mise à jour de la documentation, puis applique votre paramètre de sensibilité avant de créer une tâche de préparation.
Ajouter des instructions pour les brouillons de PR
Utilisez Instructions pour les brouillons de PR pour définir des consignes permanentes, applicables à toute l’organisation, que Fern suit lorsqu’il examine les pull requests fusionnées et prépare des brouillons à partir de celles-ci.
Le champ accepte jusqu’à 4 000 caractères. Quittez le champ pour enregistrer. Si les instructions sont vides, le paramètre est effacé.
Ce champ est distinct des instructions générales pour Fern sous Paramètres > À propos de vous, dans le champ Informations sur l’entreprise. Ces instructions guident la rédaction et les recherches générales de Fern. Instructions pour les brouillons de PR s’applique uniquement à l’examen des PR et aux brouillons générés à partir des PR.
Ce qui déclenche un brouillon
Fern prépare un brouillon à partir d’une pull request après sa fusion dans la branche de production configurée du dépôt. Si aucune branche de production n’est définie, Fern utilise la branche par défaut du dépôt. Les pull requests fusionnées dans d’autres branches sont ignorées. Les pull requests de réversion sont également ignorées.
Définissez la branche de production de chaque dépôt sur la page de l’intégration GitHub.
Fern prépare un brouillon lorsque la fusion modifie un comportement visible par les clients et que ceux-ci doivent connaître, comme des parcours dans l’interface, des points de terminaison d’API, le comportement d’une fonctionnalité, des messages d’erreur ou des options de configuration, et que le changement respecte votre paramètre de sensibilité.
Fern ne crée pas de brouillon lorsque :
Le changement est interne ou n’affecte pas les utilisateurs finaux
La documentation concernée est déjà à jour
Le changement est visible par les clients, mais ne respecte pas votre paramètre de sensibilité actuel
Dans ces cas, Fern enregistre tout de même une modification du code marquée Aucune modification de la documentation nécessaire. Ces fils restent absents de la liste Tous par défaut. Filtrez la page Fern par Automatisations pour les examiner. Ouvrez un fil pour voir son titre et les éventuelles explications enregistrées par Fern.
Examiner vos brouillons
Lorsqu’il crée un brouillon, Fern l’affiche sur votre page Fern sous la forme d’un fil accompagné d’une icône de pull request. Le fil affiche le titre et les métadonnées de la PR, un résumé des changements et l’état du brouillon.
Pour filtrer la page Fern, ouvrez Filtrer les fils dans l’en-tête de la barre latérale. Le bouton Contient des brouillons affiche uniquement les fils de tâches pouvant être examinés ; il peut donc ne pas inclure le fil de modification du code de la PR lui-même. Ouvrez directement le fil de la PR ou sélectionnez la pastille Automatisations pour le trouver.
Ouvrez le fil. Lorsque le brouillon est prêt, sélectionnez Examiner et modifier les changements. Modifiez le brouillon, demandez des révisions dans le fil ou publiez-le lorsque vous êtes satisfait.
Vous contrôlez la publication
Fern prépare les mises à jour, mais ne les publie jamais automatiquement. Chaque brouillon doit être examiné par vos soins avant d’apparaître dans votre centre d’aide.
Ignorer un brouillon comme non pertinent
Lorsqu’un brouillon ne concerne pas votre centre d’aide, marquez-le comme Non pertinent pour le retirer de votre flux sans le publier. Vous pouvez ignorer tout brouillon éligible qui attend encore un examen ; les changements publiés ou en cours de publication ne peuvent pas être ignorés.
Ouvrez le brouillon sur votre page Fern.
Sélectionnez Non pertinent.
Ajoutez une raison si vous souhaitez vous rappeler pourquoi il ne s’appliquait pas (facultatif).
Confirmez l’ignorance.
Le brouillon est fermé et disparaît de votre flux Fern principal. Il n’est pas supprimé : filtrez le flux par Automatisations pour retrouver les changements ignorés. Un changement ignoré affiche Ignoré comme non pertinent, accompagné de la raison que vous avez enregistrée, et ne propose aucune option d’examen ou de publication.