Brouillons PR automatiques
Activez les Brouillons PR automatiques dans Paramètres > Automatisations pour que Fern rédige un brouillon de mise à jour de la documentation lorsqu’une pull request fusionnée modifie un comportement visible par les clients. Vous relisez 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 dans vos dépôts.
Activer les brouillons PR automatiques
Ouvrez Paramètres depuis la barre latérale du tableau de bord.
Sélectionnez Automatisations. La page inclut Brouillons PR automatiques et les Audits planifiés.
Activez Brouillons PR automatiques. Le paramètre est enregistré immédiatement.
Lorsque le bouton est activé, Sensibilité et Consignes pour les brouillons PR apparaissent en dessous.
Choisir la sensibilité
Utilisez Sensibilité pour contrôler avec quelle facilité Fern crée un brouillon à partir d’une pull request fusionnée. Choisissez une option :
Strict : uniquement les changements évidents : Fern ne crée un brouillon que lorsque le besoin de mise à jour de la documentation est le plus manifeste.
Équilibré : l’option par défaut. Fern rédige les changements clairs visibles par les clients et ignore les cas plus faibles.
Plus réactif : davantage de brouillons : Fern crée des brouillons pour un ensemble plus large de changements visibles par les clients.
La modification du sélecteur est enregistrée immédiatement.
La sensibilité ne garantit pas qu’un brouillon sera créé pour chaque changement produit visible. Fern décide toujours si la fusion nécessite de la documentation, puis applique votre réglage de sensibilité avant de créer une tâche de brouillon.
Ajouter des consignes pour les brouillons PR
Utilisez Consignes pour les brouillons PR pour définir des instructions permanentes, à l’échelle de l’organisation, que Fern applique lorsqu’il examine les pull requests fusionnées et en rédige des brouillons.
Le champ accepte jusqu’à 4 000 caractères. Quittez le champ pour enregistrer. Des consignes vides effacent le paramètre.
Ce champ est distinct des Instructions de brouillon et des Instructions de recherche à l’échelle de l’organisation, dans Paramètres > Fern. Ceux-ci guident la rédaction et les recherches générales de Fern. Consignes pour les brouillons PR ne s’applique qu’au filtrage des PR et aux brouillons générés à partir des PR.
Ce qui déclenche un brouillon
Fern crée 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 retour en arrière sont également ignorées.
Définissez la branche de production de chaque dépôt sur la page de l’intégration GitHub.
Fern crée un brouillon lorsque la fusion modifie un comportement visible par les clients qu’ils doivent connaître, comme les parcours d’interface utilisateur, les points de terminaison d’API, le comportement des fonctionnalités, les messages d’erreur ou les options de configuration, et que la modification respecte votre réglage 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 réglage de sensibilité actuel
Dans ces cas, Fern enregistre tout de même un changement de code marqué Aucune modification de documentation nécessaire. Ces fils de discussion restent en dehors de la liste par défaut Toutes. Filtrez la page Fern par Automatisations pour les consulter. Ouvrez un fil de discussion pour voir le titre et toute explication enregistrée par Fern.
Relire 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 affiche le titre et les métadonnées de la PR, un résumé des modifications et l’état du brouillon.
Ouvrez le fil de discussion. Lorsque le brouillon est prêt, choisissez Relire et modifier les changements. Modifiez le brouillon, demandez des révisions dans le fil de discussion ou publiez-le lorsque vous êtes satisfait.
Filtrez la liste des fils de discussion Fern avec A des brouillons pour voir uniquement les fils dont les mises à jour de 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 doit être relu par vos soins avant d’apparaître dans votre centre d’aide.