Brouillons de PR automatiques
Activez Brouillons de PR automatiques dans Paramètres > Automatisations afin 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 examinez et publiez toujours chaque brouillon ; Fern ne publie jamais automatiquement.
Avant de commencer
Connectez l’intégration GitHub pour que Fern puisse surveiller les pull requests dans vos dépôts.
Activer les brouillons de PR automatiques
Ouvrez Paramètres depuis la barre latérale du tableau de bord.
Sélectionnez Automatisations. La page comprend Brouillons de PR automatiques et Audits planifiés.
Activez Brouillons de PR automatiques. Le paramètre est enregistré immédiatement.
Lorsque le bouton est activé, Sensibilité et Conseils pour les brouillons de PR apparaissent en dessous.
Choisir le niveau de 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 :
Strict : uniquement les changements évidents : Fern ne rédige un brouillon que lorsque l’argument en faveur d’une mise à jour de la documentation est le plus solide.
Équilibré : le paramètre par défaut. Fern rédige des brouillons pour les changements clairs visibles par les clients et ignore les plus faibles.
Alerte : plus de brouillons : Fern crée 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 qu’un brouillon sera créé pour chaque changement produit visible. Fern décide tout de même si la fusion nécessite une documentation, puis applique votre réglage de sensibilité avant de créer une tâche de rédaction.
Ajouter des conseils pour les brouillons de PR
Utilisez Conseils pour les brouillons de 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 conseils vides effacent le paramètre.
Ce champ est distinct des Instructions de rédaction et des Instructions de recherche à l’échelle de l’organisation dans Paramètres > Fern. Celles-ci guident la rédaction et la recherche générales de Fern. Conseils pour les brouillons de PR s’applique uniquement au filtrage des PR et aux brouillons déclenchés par les PR.
Ce qui déclenche un brouillon
Fern examine une pull request après sa fusion dans la branche par défaut du dépôt dans un dépôt GitHub connecté. Les pull requests de restauration sont ignorées avant l’examen.
Fern rédige 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 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 :
La modification est interne ou n’affecte pas les utilisateurs finaux
La documentation concernée est déjà à jour
La modification est visible par les clients, mais ne correspond pas à votre réglage de sensibilité actuel
Dans ces cas, Fern enregistre tout de même une modification de code marquée Aucune modification de documentation nécessaire. Ces fils restent en dehors de la liste Toutes par défaut. Filtrez la page Fern par Automatisations pour les examiner. Ouvrez un fil pour voir le titre et toute explication enregistrée par Fern.
Si plusieurs dépôts sont connectés, Fern peut limiter l’analyse au dépôt où la fusion a eu lieu. Pour les modifications spécifiques à une branche, Fern peut parcourir cette branche avant de rédiger.
Examiner vos brouillons
Lorsque Fern crée un brouillon, il apparaît sur votre page Fern sous forme de fil avec 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.
Ouvrez le fil. Lorsque le brouillon est prêt, choisissez Examiner et modifier les changements. Modifiez le brouillon, demandez des révisions dans le fil ou publiez-le lorsque vous êtes satisfait.
Filtrez la liste des fils Fern avec Présentant des brouillons pour n’afficher que les fils dont les mises à jour de brouillon sont prêtes à être examinées.
Vous contrôlez la publication
Fern rédige des mises à jour, mais ne les publie jamais automatiquement. Chaque brouillon nécessite votre validation avant d’apparaître dans votre centre d’aide.