Implementación de un registro de cambios
El concepto de un registro de cambios es lo suficientemente sencillo: es un archivo que tiene una lista de los cambios realizados en un proyecto, normalmente ordenados por fecha. El desglose típico es separar una lista de versiones y, después, dentro de cada versión, mostrar:
- Características agregadas
- Características modificadas o mejoradas
- Características eliminadas
Algunos equipos publicarán los registros de cambios como entradas de blog; otros usuarios crearán un archivo CHANGELOG.md en un repositorio de GitHub.
Herramientas automatizadas del registro de cambios
Aunque los registros de cambios se pueden crear y mantener manualmente, es posible que quiera considerar el uso de una herramienta de creación de registros de cambios automatizada. Al menos como punto de partida.
Uso de comandos GitHub nativos
El comando git log puede ser útil para crear contenido automáticamente. Ejemplo: creación de una sección por versión:
git log [options] vX.X.X..vX.X.Y | helper-script > projectchangelogs/X.X.Y
Registro de cambios de Git
Una herramienta estándar es gitchangelog. Esta herramienta se basa en Python.
Generador del registro de cambios de GitHub
Otra herramienta estándar se denomina github-changelog-generator.
$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0
Esta herramienta se basa en Gem.
¿Debe usar datos basados en registros generados automáticamente?
La preferencia siempre es evitar el volcado de entradas de registro en un registro de cambios. Los registros son "ruidosos", por lo que es fácil generar un desorden que no resulta útil.