Un registro de cambios (también escrito como change log [1] ) es un registro de todos los cambios notables realizados en un proyecto. El proyecto suele ser un sitio web o un proyecto de software, y el registro de cambios suele incluir registros de cambios como correcciones de errores, nuevas funciones, etc. Algunos proyectos de código abierto incluyen un registro de cambios como uno de los archivos de nivel superior en su distribución.
Históricamente, un registro de cambios incluía todos los cambios realizados en un proyecto. El sitio "Keep a Changelog" (Mantenga un registro de cambios) en cambio recomienda que un registro de cambios no incluya todos los cambios, sino que contenga "una lista ordenada cronológicamente y seleccionada de los cambios más notables para cada versión de un proyecto" y no que sea un "volcado" de un registro de Git "porque esto no ayuda a nadie". [2]
Aunque la convención de nombres canónica de GNU ( Automake ) para el archivo es ChangeLog , [3] a veces se lo nombra alternativamente como CAMBIOS o HISTORIA ( NOTICIAS es usualmente un archivo diferente que refleja cambios entre lanzamientos, no entre confirmaciones). Otra convención es llamarlo CHANGELOG . [2] Algunos mantenedores de proyectos agregarán un sufijo .txt al nombre del archivo si el registro de cambios es texto simple , un sufijo .md si está en Markdown , o un sufijo .rst si está en reStructuredText .
Algunos sistemas de control de revisiones pueden generar la información relevante para un registro de cambios, si el objetivo es incluir todos los cambios. [4]
Los archivos de registro de cambios se organizan en párrafos que definen un cambio único dentro de una función o archivo. Los estándares de codificación de GNU recomiendan el siguiente formato: [5]
AAAA-MM-DD␣␣Juan Pérez␣␣<[email protected]> * myfile.ext (myfunction): mis cambios realizados cambios adicionales. * myfile.ext (unrelated_change): mis cambios realizados a myfile.ext pero completamente ajeno a lo anterior. * anotherfile.ext (somefunction): más cambios realizados por mí.
Entre la fecha y el nombre, y nuevamente entre el nombre y la dirección de correo electrónico, hay dos espacios cada uno. Es común encerrar la dirección de correo electrónico entre < y >. El editor de Emacs crea dichas entradas al crear entradas adicionales en el registro de cambios.
Cuando un software se mantiene bajo un control de revisión como git o svn más antiguo o incluso cvs mucho más antiguo , y se distribuye a través de un paquete como RPM Package Manager , el formato del archivo Changelog es diferente y, por ejemplo:
* Lunes 5 de agosto de 2024 johndoe <[email protected]> (583f243)- myfile.ext (myfunction): mis cambios realizaron cambios adicionales.* Viernes 19 de julio de 2024 johndoe <[email protected]> (a18761f)- myfile.ext (unrelated_change): mis cambios realizados a myfile.ext pero completamente ajeno a lo anterior.* Viernes 19 de julio de 2024 johndoe <[email protected]> (a739b6f)- anotherfile.ext (somefunction): más cambios realizados por mí.
Este tipo de archivo se puede generar normalmente a partir de la base de datos interna del control de revisión utilizado. Por ejemplo, en Git, el formato de fecha debe omitir la hora y la zona horaria. En el siguiente comando, el hash de confirmación abreviado se agrega entre corchetes:
git log --date=format:"%a %b %d %Y" --pretty="tformat:* %ad %an <%ae> (%h)%n- %s%b%n" >Registro de cambios
Un paquete rpm se genera a partir de un archivo con extensión . spec y el historial de revisiones contenido en el archivo Changelog se inserta al final, después de la etiqueta %changelog. Para acceder al historial de un paquete instalado como foo.rpm, la opción de consulta es --changelog:
$ rpm -q --changelog foo* Lunes 5 de agosto de 2024 johndoe <[email protected]> (583f243)- myfile.ext (myfunction): mis cambios realizaron cambios adicionales....
La mayoría del software wiki incluye registros de cambios como una característica fundamental (a menudo llamada historial en este contexto). Por ejemplo, el enlace "Ver historial" en la parte superior [6] de una entrada de Wikipedia enlaza al registro de cambios de esa página. Esta característica es vital para cumplir con los requisitos de atribución de algunas licencias de derechos de autor. [ cita requerida ]
Un registro de cambios de productos permite mantener a los clientes informados sobre las novedades. Ayuda a anunciar nuevas funciones, los últimos lanzamientos y noticias relevantes directamente en la aplicación. [ cita requerida ]
