Skip to content
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

Open
epilys opened this issue Jul 24, 2024 · 6 comments
Open

Standardize CHANGELOG.md style format for new releases #182

epilys opened this issue Jul 24, 2024 · 6 comments

Comments

@epilys
Copy link
Member

epilys commented Jul 24, 2024

See discussion in rust-vmm/vhost-device#695

Cc @stefano-garzarella

@stefano-garzarella
Copy link
Member

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

@epilys
Copy link
Member Author

epilys commented Jul 24, 2024

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

Yes! Thank you :)

(Multitasking==bad)

@TimePrinciple
Copy link

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

@epilys
Copy link
Member Author

epilys commented Oct 24, 2024

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
Copy link
Contributor

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
Copy link
Member Author

epilys commented Oct 24, 2024

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)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants