-
Notifications
You must be signed in to change notification settings - Fork 28
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Standardize CHANGELOG.md style format for new releases #182
Comments
@epilys wrong link? Should it be rust-vmm/vhost-device#695 ? |
Yes! Thank you :) (Multitasking==bad) |
Should we use some action (or that kind of thing) to do this 🤔, or some static checks in our |
We'd need a linter tool that can check against an informal specification such as https://common-changelog.org/ or https://keepachangelog.com/en/1.1.0/ sadly there are none that fit these constraints. There's https://pypi.org/project/check-changelog/ but it seems to check for stuff ad-hoc and is incredibly buggy. Let's keep this bug opened until a good tool shows up I guess, otherwise setting a github action for it is trivial. |
There are a few tools that automate writing of changelogs (e.g. https://github.com/googleapis/release-please and rust specific https://github.com/MarcoIeni/release-plz) which could mitigate most of this issue if there was a move to avoid manually writing the changelog. |
Changelogs do require some human input I think, otherwise people will not read them at all :/ (I know I wouldn't at least). I use https://git-cliff.org/ for a hobby project and I'm happy with it, but its output always requires editing (sometimes the imperative git voice doesn't sound suitable for changelogs) |
See discussion in rust-vmm/vhost-device#695
Cc @stefano-garzarella
The text was updated successfully, but these errors were encountered: