DEV Community

Discussion on: Please don't forget to write the changelog

Collapse
 
osde8info profile image
Clive Da

no need to write it ! just autogen from your github commits !

Collapse
 
somedood profile image
Basti Ortiz

Yup, that's fine, too! But of course, a personal touch is always better than automatically generated changelogs. 😉

But if the time and resource constraints are indeed limited, then that is a viable option.

Collapse
 
joelbonetr profile image
JoelBonetR 🥇

Best thing that worked to me is to squash on merge request, so you can use whatever commit message you want during development, use a nice "changelog" message just on the merge request, then you can generate the entire changelog from the main branch and it will be perfectly fine. Best of both worlds! 😁

Thread Thread
 
somedood profile image
Basti Ortiz

True enough, I've been seeing this more frequently in many open-source projects thanks to the rise of GitHub Actions and other automations. I personally still prefer the labor of love that comes from a handwritten changelog1, but something is better than nothing. I cannot complain about that.


  1. See this recent example from the Bevy game engine. 

Thread Thread
 
joelbonetr profile image
JoelBonetR 🥇

You can achieve exactly the same!
you put a bit of effort and love the same way, just on a different stage 😂
Just write your MR comments in markdown and post-it with a parser process (just like dev.to does in posts and comments) 😁