Actualiza la documentación al combinar una solicitud de extracción
Fern redacta una actualización del centro de ayuda cuando combinas una solicitud de extracción que cambia algo que ven tus clientes. Cada borrador espera a que lo revises. Fern nunca publica por su cuenta.
Necesitas la aplicación de GitHub de Ferndesk en tus repositorios. Los propietarios y administradores pueden cambiar esta opción.
Elige de qué solicitudes de extracción redacta Fern
Los espacios de trabajo nuevos empiezan con Cambios visibles para los usuarios. Para cambiarlo, ve a Fern > Personalizar > Automatizaciones y configura Redactar a partir de PR combinadas:
Opción | Fern redacta para |
|---|---|
Funciones principales | Solo los cambios más importantes que afectan a los clientes |
Cambios visibles para los usuarios | Cualquier cambio que tus clientes noten |
Todas las PR | El conjunto más amplio de cambios, incluidos los pequeños |
Desactivado | Nada |
Con cualquier opción, Fern no redacta nada para las fusiones que no requieren cambios en la documentación. Para establecer reglas permanentes, añade Instrucciones de filtro en el mismo menú; por ejemplo: «Omitir PR etiquetadas como chore o refactor».
Iniciar sesión con GitHub no es suficiente. Si la aplicación de GitHub de Ferndesk no está instalada en tus repositorios, la opción indica que aún no se puede ejecutar. Instala la aplicación desde Conectar GitHub.
Qué fusiones lee Fern
Fusiones en la rama de producción de cada repositorio. Esa es la rama predeterminada, a menos que configures una Rama de producción para el repositorio en la página de integración de GitHub.
Si tu rama predeterminada es staging, pero los clientes reciben lo que está en main, configura main como rama de producción. Entonces Fern redactará una sola vez, cuando la solicitud de extracción de la versión se fusione en main.
Solo los repositorios habilitados para la documentación en la misma página.
No se incluyen reversiones. Se omiten las solicitudes de extracción cuyo título empieza por «Revert».
Fern redacta a partir de solicitudes de extracción combinadas, no de versiones ni etiquetas de GitHub. Si prefieres documentar cada versión, configura Redactar a partir de PR combinadas como Desactivado y pídele a Fern que lo haga cuando publiques una versión, adjuntando las notas de la versión.
Cuando una fusión no requiere cambios en la documentación, o es menor que lo que indica la opción Redactar a partir de PR combinadas, Fern la registra como No se necesitan cambios en la documentación, junto con los motivos. Filtra la lista de Fern por Automatizaciones para ver estos casos.
Qué cuenta como revisión de una PR
Cada solicitud de extracción combinada que Fern revisa consume una revisión de PR, tanto si Fern redacta una actualización como si no. Esto incluye las fusiones que Fern determina que no requieren cambios en la documentación, las que Fern omite según tus Instrucciones de filtro y las que son menores que lo que indica la opción Redactar a partir de PR combinadas. Las fusiones que Fern no lee (consulta más arriba) y las tareas que inicias por tu cuenta no consumen ninguna. La cantidad incluida en tu plan aparece en Límites de uso.
Si agotas tus revisiones de PR, Fern dejará de revisar las fusiones hasta que se restablezca la cantidad incluida en tu plan o compres más; las fusiones que se produzcan durante ese tiempo no se revisarán más adelante. Los propietarios y administradores pueden consultar Revisiones de PR y comprar más en Configuración > Espacio de trabajo > Uso.
Revisar un borrador
Cada borrador aparece en Fern como un hilo para su solicitud de extracción, con un resumen de los cambios. Elige Revisar y editar los cambios para editarlos y publicarlos, o No es relevante si no se debe documentar. Un hilo marcado como «No es relevante» desaparece de la lista y permanece bajo el filtro Automatizaciones.
Si una fusión no generó un borrador, consulta Solucionar problemas de Fern.