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
[–] [S] 4 points 1 year ago* (last edited 1 year ago) (1 child)

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.

  • source
  • parent
  • hideshow 1 child comment