CHANGELOG.md Generador de plantillas
Genere plantillas CHANGELOG.md compatibles con Keep-a-Changelog con grupos de versiones semánticas, registros no publicados y referencias de comparación de etiquetas Git automatizadas.
Fill in your project name, repository link, and release version logs to export a Keep-a-Changelog standard markdown document.
Display name of your application.
A brief, one-sentence tagline.
Required to generate Git tag comparison links.
Determines formatting structure and links.
Release Version History & Logs
¿Por qué utilizar nuestro generador de plantillas CHANGELOG.md?
- Estándar Keep-a-Changelog: Garantiza el estricto cumplimiento de las especificaciones. Nuestra herramienta genera registros de cambios estándar v1.1.0 que contienen categorías semánticas estándar correctamente ordenadas.
- Enlaces de comparación automatizados: aumente la credibilidad del repositorio. Proporcione la URL de su repositorio de GitHub para compilar automáticamente las URL de referencia de comparación entre todas las etiquetas en la parte inferior.
- Múltiples formatos de salida: obtenga el formato que se adapte a su flujo de trabajo. Exporte como Markdown Keep-a-Changelog, viñetas del registro de cambios comunes o Markdown limpio de las notas de la versión de GitHub.
- 100% privacidad del lado del cliente: mantenga seguros los detalles de su proyecto. El generador maneja todos los parámetros de formulario, registros de lanzamiento y representación de plantillas localmente dentro de su navegador web.
¿Qué es el estándar Keep-a-Changelog?
Keep a Changelog es una especificación comunitaria ampliamente adoptada que establece una estructura uniforme y legible por humanos para los registros de modificación de proyectos. En lugar de agrupar todas las actualizaciones en una única lista con viñetas masiva, el estándar define estrictamente seis grupos semánticos: **Agregado, Modificado, Obsoleto, Eliminado, Corregido y Seguridad**. Esta agrupación categorizada hace que sea increíblemente fácil para los desarrolladores, administradores y usuarios finales escanear las notas de su versión y localizar rápidamente adiciones de funciones críticas, alertas de obsolescencia o actualizaciones de seguridad.
Por qué los registros de confirmación de Git no sustituyen a los registros de cambios
Muchos desarrolladores descargan por error sus registros de Git sin procesar directamente en un archivo de texto y lo llaman registro de cambios. Sin embargo, los registros de git están diseñados para **máquinas y compiladores** y están llenos de microconfirmaciones, correcciones de errores tipográficos, registros de ramas fusionadas y notas centradas en el código. Un registro de cambios profesional está diseñado para **personas**. Selecciona esas confirmaciones, filtra las actualizaciones sin consecuencias y traduce los cambios sin procesar en descripciones claras y orientadas al usuario. Los registros escritos a mano garantizan que los desarrolladores puedan leer y comprender las novedades y cómo afecta su integración.
Los principios básicos del control de versiones semántico (SemVer)
Adherirse al control de versiones semántico representa la base de los ecosistemas de software estables. Un número de versión de SemVer está estructurado como Major.Minor.Patch (por ejemplo, 1.2.3). La versión **PATCH** aumenta cuando publicas correcciones de errores compatibles con versiones anteriores. La versión **MENOR** aumenta cuando agrega funciones nuevas compatibles con versiones anteriores. La versión **MAJOR** está reservada para modificaciones importantes de la API que requieren que los usuarios actualicen sus integraciones. El seguimiento de estas versiones dentro de un registro de cambios estructurado mantiene sus dependencias seguras y transparentes.
El poder de los enlaces de comparación automatizados de Git
Un registro de cambios verdaderamente profesional no solo enumera las versiones, sino que las conecta. Al incluir referencias de enlaces de comparación en la parte inferior de su archivo, los usuarios pueden hacer clic en cualquier número de versión para ver la diferencia de código exacta en GitHub entre la versión actual y la etiqueta anterior. Este generador compila automáticamente estos enlaces de referencia de comparación en función de la URL de su repositorio. Asigna versiones posteriores a directorios de comparación de GitHub y etiqueta la versión inicial correctamente, lo que aumenta la confianza y la transparencia de los desarrolladores.
Preguntas frecuentes
El generador de plantillas CHANGELOG.md es una herramienta en línea gratuita que crea automáticamente archivos CHANGELOG.md compatibles con Keep-a-Changelog y listos para producción. Admite elementos de lanzamiento personalizados, secciones inéditas y enlaces de comparación automatizados de Git.
La especificación define exactamente seis categorías para agrupar todas las modificaciones de código: Agregado (nuevas funciones), Modificado (cambios en funciones existentes), Obsoleto (funciones que se eliminarán próximamente), Eliminado (funciones eliminadas), Corregido (correcciones de errores) y Seguridad (parches y mejoras de seguridad).
Al proporcionar la URL de su repositorio de GitHub, el generador compila automáticamente las referencias de comparación de Markdown en la parte inferior del archivo. Al hacer clic en el encabezado de una versión de lanzamiento, los usuarios acceden directamente a la vista de comparación de diferencias de GitHub que muestra los cambios entre la etiqueta de lanzamiento actual y la etiqueta anterior.
Los registros de confirmación de Git son técnicos, detallados y están destinados a máquinas. Un registro de cambios escrito a mano está diseñado específicamente para lectores humanos. Filtra confirmaciones triviales, agrupa los cambios en categorías semánticas limpias y explica el beneficio o impacto real de los cambios.
La herramienta proporciona un formato de rebajas específico de GitHub Releases que elimina los metadatos del encabezado y los enlaces de referencia. Esto proporciona listas de viñetas limpias y que se pueden copiar y pegar agrupadas por emojis, adecuadas para pegarse directamente en los paneles de lanzamiento de GitHub/GitLab.
¡Sí! Puede especificar cualquier etiqueta de versión semántica estándar, incluidas etiquetas previas al lanzamiento como 1.0.0-beta.1 o 1.0.0-rc.2. El sistema de validación lo procesará correctamente según la especificación SemVer 2.0.0.
Sí, 100%. Todo el procesamiento y la compilación de plantillas se realizan localmente en su navegador web utilizando JavaScript del lado del cliente. Nunca se transmiten ni cargan variables de entorno, configuraciones de puertos, claves secretas o fragmentos de código a ningún servidor, lo que garantiza una privacidad total.