Qué son los changelogs y por qué son importante crearlos

Última actualización:

¿Sabes lo que es un changelog? Un changelog, como vimos en el artículo de Acrónimos y tecnicismos del desarrollo web, es una lista con los cambios más importantes realizados en un periodo de tiempo. Normalmente los changelogs se crean entre versiones, para tener un control o incluso informar a los usuarios de las mejoras realizadas.

Es importante saber que básicamente yo diferencio dos tipos de changelogs:

  • Releases de negocio: Estos sirven para usuarios no técnicos, para que descubran las nuevas funcionalidades.
  • Técnicos: Estos suelen tener lista de cambios a nivel técnico, un poco para controlar qué cambios en el código ha habido en el proyecto.

Es por eso que los changelogs son muy importantes, pero muchas veces pasamos de ellos y ni los creamos (me incluyo), pero ahora veremos que sirven para muchas cosas.

Para empezar, los changelogs sirven para los desarrolladores, para entender qué cambios se han hecho sin tener que recurrir a mirar los commits. Te sirve para refresecar la memoria de lo que ha sucedido en los sprints del proyecto.

También sirven, si se hace público, para mostrar al mundo los cambios que se han ido realizando. Es una exposición del valor que aportas a los usuarios a lo largo del tiempo.

A muchos usuarios les gustan los changelogs porque se enteran de las novedades que han habido en el producto sin tener que encontrárselas de golpe.

Para inversores y early adopters un changelog puede servir para ver la evolución que ha tenido a lo largo del tiempo un producto y así poder tener más datos para tomar una decisión sobre el producto.

Incluso si se publican las novedades en redes sociales puede ayudar al marketing y a que más gente lo comparta y lo descubra.

Para escribir los changelogs hay muchas técnicas, lo más sencillo es hacerlo a mano, así puedes controlar qué cosas quieres mostrar en el changelog y de qué manera.

Hay que tener cuidado porque si se hace a mano y no se tiene una disciplina y rutina, es fácil que se queden desfasados con el paso del tiempo.

Por eso hay mucha gente que los automatiza, por ejemplo usando los propios mensajes de commit si se usa un sistema estándar como Conventional commits .

En definitiva, un changelog puede ser una gran herramienta a considerar, sobre todo si aportan valor, no como algunos changelogs de apps de la Play Store de Android, que suben nueva versión y ponen como cambios “Some fixes”.

Changelogs que me han gustado

El que primero me llamó la atención fue el de Gitkraken, con uno de sus vídeos descubrí su producto y lo usé durante un tiempo.

https://support.gitkraken.com/release-notes/current/

https://i.imgur.com/EpE2uog.png

El changelog de la aplicación de Linear también me gusta bastante, suelen acompañar los cambios de capturas o de Gif para mostrar los cambios:

https://linear.app/changelog

https://i.imgur.com/zmTvnbz.png

Los changelogs de Gitlab son muy muy completos, explican muchas cosas:

https://about.gitlab.com/releases/categories/releases/

https://i.imgur.com/JHyjlTR.png