16
Automated changelog generation (fhoekstra.eu)
submitted 1 day ago by fhoekstra@feddit.nl to c/programming@programming.dev
7 comments fedilink hide all child comments

When publishing a package for use by programmers, automated changelog generation is very beneficial. In this blog post, I explore how to do it in a simple way that works everywhere.

you are viewing a single comment's thread
view the rest of the comments
[-] MajorHavoc@programming.dev 7 points 1 day ago

Oh, nice.

I'm always looking for another ChangeLog tool.

That said, I never leave my ChamgeLogs up to automation.

My git logs are open to my users for full details, but my ChangeLogs are how I communicate which changes my users probably need to be aware of.

So far, this hasn't yielded well to automation. But my team is still considering standardizing our commit log messages enough to allow it someday.

[-] fhoekstra@feddit.nl 4 points 1 day ago* (last edited 19 hours ago)

Thanks for your feedback!

Some thoughts:

  • You could configure your cliff.toml (generated with git-cliff --init) to ignore any commits that aren't interesting to your users
  • You could use "squash merge" to the prerelease/staging/development branch so that you can commit without worry, and then only have your PR titles follow conventional commits (if the change is interesting to your users)

I should probably add those to the blog.

But yeah, I get preferring to write manual tailored changelogs. Personally I am just a little neurotic about single source of truth and a huge Git nerd. And I know that at least in this job, my users are neurotic enough to prefer completeness.

[-] MajorHavoc@programming.dev 3 points 19 hours ago

We do always squash merge, which certainly helps.

I was not aware of cliff.toml. Thank you!

this post was submitted on 08 Nov 2025
16 points (100.0% liked)

Programming

23403 readers
74 users here now

Welcome to the main community in programming.dev! Feel free to post anything relating to programming here!

Cross posting is strongly encouraged in the instance. If you feel your post or another person's post makes sense in another community cross post into it.

Hope you enjoy the instance!

Rules

Rules

  • Follow the programming.dev instance rules
  • Keep content related to programming in some way
  • If you're posting long videos try to add in some form of tldr for those who don't want to watch videos

Wormhole

Follow the wormhole through a path of communities !webdev@programming.dev

founded 2 years ago
MODERATORS
snowe@programming.dev
Ategon@programming.dev
MaungaHikoi@lemmy.nz
UlrikHD@programming.dev