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
Follow the wormhole through a path of communities !webdev@programming.dev
@fhoekstra Such tools are worse than useless. Every time I see an automated changelog it's mix of dependabot commits, "fix CI" and other meaningless messages.
Not having a changelog is better, because then you just go straight to a commit history and don't waste your time trying to parse machine-generated slop.
At work, I set up convco for automated commit checks and changelog generation with custom/slightly adjusted configuration of conventional commits (types) and changelog template.
Nice, I hadn't heard of that one yet!
IMO automated changelogs like these are not especially useful. Better than no changelog I guess, but nowhere near as good as a proper changelog. But proper changelogs take actual effort.
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.
Thanks for your feedback!
Some thoughts:
cliff.toml (generated with git-cliff --init) to ignore any commits that aren't interesting to your usersI 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.
We do always squash merge, which certainly helps.
I was not aware of cliff.toml. Thank you!