Our great sponsors
-
git-cliff
A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️
-
WorkOS
The modern identity platform for B2B SaaS. The APIs are flexible and easy-to-use, supporting authentication, user identity, and complex enterprise features like SSO and SCIM provisioning.
-
shipkit-changelog
Minimalistic Gradle plugin that generates changelog based on commit history and GitHub pull requests/issues
-
GitHub Changelog Generator
Automatically generate change log from your tags, issues, labels and pull requests on GitHub.
-
InfluxDB
Power Real-Time Data Analytics at Scale. Get real-time insights from all types of time series data with InfluxDB. Ingest, query, and analyze billions of data points in real-time with unbounded cardinality.
We’ve been using charmixer/auto-changelog-action to generate release notes. This action makes nice references to GitHub pull requests. The release notes are attached to a GitHub release by an action. This turns out to be an invaluable reference for SQA and Product Manager for testing and creating customer-facing release notes.
One downside is that we run into trouble with GitHub API rate-limiting.
A similar project, tightly integrated with Gradle: https://github.com/shipkit/shipkit-changelog
I initially was interested in Rust because of performance + speed + safety, but now I have to say that cargo is a big selling point for me.
I always used to be scared of compiling software myself because I never seemed to be able to get it to work without endless headaches. Now, I generally find it easy to compile Rust programs if they aren't in my package manager, and with cargo install-update https://github.com/nabijaczleweli/cargo-update I find it easy to keep the software up to date. I have higher confidence that I can get hobbyist Rust software working, and the more Rust software I use, the more familiar I am with the ecosystem and the more comfortable I am.
If this was written in some obscure language I wasn't familiar with, I'd be less confident I would be able to run it at all, let alone keep it updated, and I may not bother even trying to install it.
gnulib and a lot of GNU projects have this for a long time. https://github.com/coreutils/gnulib/blob/master/build-aux/gi...
While auto-generated changelogs aren't the best, they are better than nothing. Too often I've seen projects without a changelog which is especially annoying when dealing with breaking changes.
I've been considering switching to a changelog generator, either from Conventional Commits or from a folder of files just to avoid merge conflicts with the CHANGELOG file.
If people want enforcement of Conventional Commit, check out https://github.com/crate-ci/committed
Related posts
- Adding GitHub integration to git-cliff (need opinions/comments)
- Auto-Generated Customer-Friendly Changelogs
- changelog-gh-usernames: A tool to replace emails in changelogs with GitHub usernames
- Hey everyone, exciting news! Git-Cliff just dropped version 1.0.0! Who else is psyched to try it out? Let's hear your thoughts in the comments! 🚀🎉
- git-cliff 1.2.0 is released! (highly customizable changelog generator)