search

DeterminateSystems / riff

Riff automatically provides external dependencies for Rust projects, with support for other languages coming soon.
https://riff.sh
Mozilla Public License 2.0
486 stars 13 forks source link

Add auto-generated changelog #130

Closed lucperkins closed 1 year ago

lucperkins commented 2 years ago

It's not particularly fancy but this PR provides an initial CHANGELOG.md file and a convenient means of generating it.

cole-h commented 1 year ago

I haven't forgotten about this, but I'm also not completely enthused with the approach.

If we're going to use an auto-generated changelog, I'd much rather use the one that GitHub generates when I go to tag a release. And if we're going to keep a changelog file, I'd much rather have it be a legitimate changelog (along the lines of https://keepachangelog.com/en/1.0.0/), rather than something auto-generated.

That said, these aren't strongly held opinions, and I'd be open to having my view changed.

lucperkins commented 1 year ago

@cole-h I don't disagree and I'm totally open to whatever. In my experience, a generated file can serve as a starting point for a more curated changelog, i.e. we could potentially use this tool/approach to generate a raw list of commits ordered by version and then prettify the text, delete extraneous commits, etc. Let me know if you have any specific wishes here and I'll see what I can do.

cole-h commented 1 year ago

I think for the moment, it's not particularly necessary or useful to maintain a changelog (auto-generated or otherwise), especially since GitHub will generate one for us when we go to release it. That said, we might want to revisit this in the future (so it's not entirely a lost cause).