Implementación de un registro de cambios

  • 3 minutos

Un registro de cambios es sencillo: es un archivo que enumera los cambios realizados en un proyecto, normalmente organizados por fecha. El formato típico muestra las versiones, y para cada versión enumera:

  • Características agregadas : nuevas cosas que puede hacer
  • Características modificadas o mejoradas : cosas que funcionan mejor
  • Características eliminadas : cosas que se quitaron

Algunos equipos publican registros de cambios como entradas de blog. Otros crean un archivo CHANGELOG.md en su repositorio de GitHub.

Herramientas automatizadas de registro de cambios

Aunque puede crear y mantener manualmente los registros de cambios, es posible que desee usar una herramienta automatizada para ayudarle. Al menos como punto de partida.

Uso de comandos nativos de Git

El git log comando puede ayudarle a crear contenido automáticamente. Por ejemplo, cree una nueva 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 popular es gitchangelog. Esta herramienta está escrita en Python.

Generador de registro de cambios de GitHub

Otra herramienta popular se denomina github-changelog-generator.

$ github_changelog_generator -u github-changelog-generator -p TimerTrend-3.0

Esta herramienta se basa en Ruby Gem.

¿Debe usar datos basados en registros generados automáticamente?

Normalmente, es mejor evitar simplemente copiar entradas de registro en un registro de cambios. Los registros contienen demasiados detalles técnicos, por lo que es fácil crear un desorden confuso que no ayuda a los usuarios a comprender lo que ha cambiado.