Formatee una entrada Keep a Changelog por tipos de cambio

Indique versión, fecha y listas de elementos añadidos, cambiados, corregidos o eliminados. El formateador conserva el orden, omite secciones vacías y devuelve Markdown listo para incorporar al registro. Su resultado determinista resulta útil en scripts de publicación, entrega continua, herramientas de repositorio y revisiones editoriales.

Prepare la información antes de formatearla

Comience con una versión y una fecha, y clasifique cada novedad en añadido, cambiado, corregido o eliminado. Redacte descripciones breves y completas, comprensibles sin referencias internas. El formateador no inventa ni resume contenido: conserva sus palabras y el orden de cada lista. Puede omitir grupos vacíos. La versión y la fecha deben contener texto; para la fecha conviene usar YYYY-MM-DD, un formato fácil de ordenar y reconocer internacionalmente. Reserve Añadido para funciones disponibles por primera vez. Use Cambiado cuando varíe un comportamiento, una interfaz, un valor predeterminado o el rendimiento. Corregido documenta defectos resueltos y Eliminado avisa de funciones que dejaron de estar disponibles. Esta separación permite identificar rápidamente el impacto del lanzamiento.

Comprenda la estructura Markdown generada

El resultado comienza con un encabezado de segundo nivel que muestra la versión entre corchetes y la fecha. Después aparecen únicamente los grupos no vacíos, siempre en el orden Añadido, Cambiado, Corregido y Eliminado. Cada grupo usa un encabezado de tercer nivel y viñetas. Se recortan espacios y se elimina una viñeta inicial ya existente para evitar duplicados. El campo changelog termina con un salto de línea y la misma entrada válida siempre produce idéntico texto en navegador y API. El orden no depende de cómo lleguen las propiedades. Esta estabilidad facilita comparar resultados, escribir pruebas y concatenar entradas. Tampoco intervienen la hora actual, la configuración regional, valores aleatorios, respuestas de red ni estados ocultos.

Integre el formateador en su publicación

Úselo después de aprobar el contenido de las notas y antes de insertarlo en el archivo del repositorio. Un script puede reunir descripciones estructuradas, solicitar el formato y presentar el resultado para revisión o entregarlo a otro paso que actualice el archivo. La capacidad no lee commits, consulta incidencias, modifica archivos ni elige versiones semánticas. Revise el resultado dentro del changelog completo si emplea encabezados o enlaces propios. Para lanzamientos públicos, describa el efecto perceptible en lugar de detalles internos. En herramientas internas, aporte precisión sobre migraciones, compatibilidad y funciones retiradas. Separar redacción y formato permite revisar la exactitud sin discutir variaciones de Markdown y mantiene la automatización fácil de probar. Cada solicitud mediante la API cuesta $0.002.