Actualizar la documentación al combinar una solicitud de incorporación
Fern redacta una actualización del centro de ayuda cuando combinas una solicitud de incorporació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 incorporación redacta Fern
Los espacios de trabajo nuevos empiezan con Cambios que afectan a 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 que afectan a los usuarios | Cualquier cambio que tus clientes vayan a notar |
Todas las PR | El conjunto más amplio de cambios, incluidos los pequeños |
Desactivado | Nada |
Con cualquier configuración, Fern omite las combinaciones que no requieren cambios en la documentación. Para establecer reglas permanentes, añade Instrucciones de filtrado en el mismo menú; por ejemplo: «Omitir las 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 configuración indica que todavía no se puede ejecutar. Instala la aplicación desde Conectar GitHub.
Qué combinaciones consulta Fern
Combinaciones 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. Fern redactará un borrador cuando se combine en main la solicitud de incorporación de la versión.
Solo los repositorios en los que se haya habilitado la documentación en la misma página.
No se incluyen las reversiones. Se omiten las solicitudes de incorporación cuyo título empieza por «Revert».
Fern redacta a partir de solicitudes de incorporación combinadas, no de versiones ni etiquetas de GitHub. Para 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 combinación no requiere cambios en la documentación, 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 estas entradas.
Qué se considera una revisión de PR
Cada borrador que Fern inicia a partir de una solicitud de incorporación combinada consume una revisión de PR. Las combinaciones que Fern omite o determina que no requieren cambios en la documentación no consumen ninguna, y las tareas que inicias tú nunca lo hacen. Consulta la asignación de tu plan en Límites de uso.
Si agotas las revisiones de PR, Fern dejará de redactar a partir de combinaciones hasta que se restablezca la asignación, y esas combinaciones no recibirán un borrador más adelante. Consulta Revisiones de PR en Configuración > Uso.
Revisar un borrador
Cada borrador aparece en Fern como un hilo correspondiente a su solicitud de incorporación, con un resumen de los cambios. Elige Revisar y editar cambios para editar y publicar, o No es relevante si no se debe documentar. Un hilo marcado como No es relevante desaparece de tu lista y queda bajo el filtro Automatizaciones.
Si una combinación no generó un borrador, consulta Solucionar problemas de Fern.