The Subtle Art of the Changelog

Re:The Subtle Art of the Changelog by nickcw on Wednesday January 25, 2023 @02:39PM (#34523103)

When I make rclone releases I usually spend an hour or two taking the git log, removing irrelevant stuff and rewriting messages to make them make sense from a users point of view.

I then take that and try to pick the top 3 or so items for use in the summary.

I then rewrite the summary condensing into a tweet.

It's a lot of work!

[ Parent | on HN ]

Re:The Subtle Art of the Changelog by sgbeal on Wednesday January 25, 2023 @07:45PM (#34526338)

> It's a lot of work!

But it's a godsend for those who care about it (as you obviously do or you wouldn't put in the effort). It was only through a recent changelog entry in Emscripten that i was able to locate a truly obscure bug in the sqlite3 wasm builds (triggered by a default-value change in Emscripten's stack size). Without that hint i'd _still_ be searching for the cause of that bug (more than a month later).

[ Parent | on HN ]

Re:The Subtle Art of the Changelog by account42 on Thursday January 26, 2023 @09:46AM (#34532202)

I have started to update the changelog file with each commit (that does something changelog-worthy) just so that I don't have to do all that work when releasing a new version.

[ Parent | on HN ]