Can we have meaningful changelogs?

From a user perspective, automatically linking PRs like this one Feature/dron 101 by d1wilko · Pull Request #391 · drone/drone-ui · GitHub in a change log is quite useless. As a user, I read through the change log to get information about what has changes. Too often users end up on PRs like this with a meaningless title, without a description or anything else.

On a closer look at the latest Drone server release:

v2.5.0 (2021-11-16)

Full Changelog

Implemented enhancements:

    bump ui to v2.4.0 #3160 (eoinmcafee00)
    # Cards? What are cards? thats the first time the change log s mentioning cards in general. There is no useful description in the PR.
    # Cards again, still no idea what that means.
    add new endpoint for uploading cards #3159 (eoinmcafee00)
    # Heck, cards again...
    refactor create / find / delete end points for cards #3158 (eoinmcafee00)
    bump ui to v2.3.1 #3155 (d1wilko)
    # ... and again
    provide ability to create/read/store card data in drone server #3149 (eoinmcafee00)
    # Also pretty short description that is hard to understand
    (DRON-124) adding new status endpoint #3143 (tphoney)

Fixed bugs:

    fix a typo in readme #3150 (nothatDinger)

Please keep in mind that this is just an example, the problem exists for other repos like the Drone UI and does not only affect the latest version either. This is just an example, the issue exists for other repos like the Drone UI as well and does not only affect the latest version either.

As a user/admin of Drone servers, I would expect the change log to help me to understand the introduced changes, or is the change log not meant to be read by end users?

1 Like