Peter Huene (Feb 26 2020 at 23:53): Peter Huene (Feb 26 2020 at 23:53):We've released 0.12.0 to crates.io and the .NET nuget package.
Peter Huene (Feb 26 2020 at 23:55):I think we should add a CHANGELOG.md to track release changes as well as include the relevant part to the GitHub release entry's markdown (right now each release only contains the tagged commit message, which is usually a version bump).
Alex Crichton (Feb 27 2020 at 00:05):I'm always a fan of changelogs myself
Alex Crichton (Feb 27 2020 at 00:05):we can edit the new contributing-release-process.md as a reminder :D
fitzgen (he/him) (Feb 27 2020 at 00:06):also it can help to have an unreleased section, so people can add notable things to it as they land them
Josh Triplett (Feb 27 2020 at 00:07):Minor request: could we call it NEWS.md or RELEASE-NOTES.md rather than CHANGELOG.md? To me, "NEWS" implies release notes, while "CHANGELOG" implies commit-by-commit details.
fitzgen (he/him) (Feb 27 2020 at 00:08):I would personally lean towards CHANGELOG.md just because it seems to be the most popular convention
Josh Triplett (Feb 27 2020 at 00:11):Rust uses RELEASES.md. I haven't seen a project that uses CHANGELOG.md for release notes. and in general if I see a file named "changelog" I tend to automatically ignore it as likely redundant with git log.
Peter Huene (Feb 27 2020 at 00:26):I'm :+1: on RELEASES.md
Alex Crichton (Feb 27 2020 at 17:08):I've sent a PR for RELEASES.md at https://github.com/bytecodealliance/wasmtime/pull/1011
Last updated: Nov 22 2024 at 16:03 UTC