Mettre à jour la documentation lors de la fusion d’une pull request
Fern prépare un brouillon de mise à jour du centre d’aide lorsque vous fusionnez une pull request qui modifie un élément visible par vos clients. Chaque brouillon attend votre validation. Fern ne publie jamais de son propre chef.
Nécessite l’application GitHub Ferndesk sur vos dépôts. Les propriétaires et les administrateurs peuvent modifier ce paramètre.
Choisir les pull requests à partir desquelles Fern prépare des brouillons
Les nouveaux espaces de travail utilisent Modifications visibles par les utilisateurs. Pour modifier ce paramètre, accédez à Fern > Personnaliser > Automatisations et définissez Créer des brouillons à partir des PR fusionnées :
Option | Fern prépare des brouillons pour |
|---|---|
Fonctionnalités majeures | Uniquement les changements les plus importants visibles par les clients |
Modifications visibles par les utilisateurs | Tout changement que vos clients remarqueront |
Toutes les PR | L’ensemble le plus large de changements, y compris les changements mineurs |
Désactivé | Rien |
Quel que soit le paramètre, Fern ignore les fusions qui ne nécessitent aucune modification de la documentation. Pour appliquer des règles permanentes, ajoutez des Instructions de filtrage dans le même menu, par exemple « Ignorer les PR portant l’étiquette chore ou refactor ».
Se connecter avec GitHub ne suffit pas. Si l’application GitHub Ferndesk n’est pas installée sur vos dépôts, le paramètre indique qu’il ne peut pas encore être utilisé. Installez l’application depuis Connecter GitHub.
Fusions prises en compte par Fern
Fusions vers la branche de production de chaque dépôt. Il s’agit de la branche par défaut, sauf si vous définissez une Branche de production pour le dépôt sur la page de l’intégration GitHub.
Si votre branche par défaut est staging, mais que vos clients utilisent le contenu de main, définissez main comme branche de production. Fern ne prépare alors qu’un seul brouillon, lorsque la pull request de mise en production est fusionnée dans main.
Uniquement les dépôts pour lesquels la documentation est activée sur cette même page.
Pas de retours arrière. Les pull requests dont le titre commence par « Revert » sont ignorées.
Fern prépare des brouillons à partir des pull requests fusionnées, et non des versions ou des tags GitHub. Pour documenter chaque version à la place, définissez Créer des brouillons à partir des PR fusionnées sur Désactivé, puis demandez à Fern de s’en charger lorsque vous publiez une version, en joignant les notes de version.
Lorsqu’une fusion ne nécessite aucune modification de la documentation, Fern l’enregistre avec la mention Aucune modification de la documentation nécessaire et en indique les raisons. Filtrez la liste de Fern par Automatisations pour les afficher.
Ce qui compte comme une revue de PR
Chaque brouillon que Fern prépare à partir d’une pull request fusionnée utilise une revue de PR. Les fusions ignorées par Fern, ou pour lesquelles Fern estime qu’aucune modification de la documentation n’est nécessaire, n’en utilisent pas. Les tâches que vous démarrez vous-même n’en utilisent jamais. Le quota de votre forfait est indiqué dans Limites d’utilisation.
Si vous n’avez plus de revues de PR, Fern cesse de préparer des brouillons à partir des fusions jusqu’à la réinitialisation du quota. Aucun brouillon ne sera créé ultérieurement pour ces fusions. Consultez Revues de PR dans Paramètres > Utilisation.
Examiner un brouillon
Chaque brouillon apparaît dans Fern sous la forme d’un fil de discussion associé à sa pull request, accompagné d’un résumé des changements. Sélectionnez Examiner et modifier les changements pour les modifier et les publier, ou Non pertinent s’ils ne doivent pas être documentés. Un fil marqué comme non pertinent disparaît de votre liste et reste accessible avec le filtre Automatisations.
Si aucun brouillon n’a été créé pour une fusion, consultez Résoudre les problèmes liés à Fern.