search

rust-vmm / community

rust-vmm community content
499 stars 27 forks source link

Standardize CHANGELOG.md style format for new releases #182

Open epilys opened 3 months ago

epilys commented 3 months ago

See discussion in https://github.com/rust-vmm/vhost-device/pull/695

Cc @stefano-garzarella

stefano-garzarella commented 3 months ago

@epilys wrong link? Should it be https://github.com/rust-vmm/vhost-device/pull/695 ?

epilys commented 3 months ago

@epilys wrong link? Should it be rust-vmm/vhost-device#695 ?

Yes! Thank you :)

(Multitasking==bad)

TimePrinciple commented 2 weeks ago

Should we use some action (or that kind of thing) to do this 🤔, or some static checks in our rust-vmm-ci

epilys commented 2 weeks ago

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.

JonathanWoollett-Light commented 2 weeks ago

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.

epilys commented 2 weeks ago

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)