Masstransit: Add release notes for atleast every major release

Created on 18 Apr 2018  路  2Comments  路  Source: MassTransit/MassTransit

This is added as an issue, as i legitimately think that missing release notes for a major project is an issue

MassTransit release notes

https://github.com/MassTransit/MassTransit/releases

Short description of my own problem
We begun to use MassTransit on a smaller project some time ago and we have been very happy with the functionality. Since we liked what we saw, we decided to use it again on a new, larger project.
We couldnt find any release notes, so a decition was made to use v4.0.1, so we could have as much new functionality as possible. Quickly we found, that this version suffered from major memory leak issues. 馃憥

We then begun to look for a replacement, and here we have also been having issues, since we can't seem to find any release notes describing what is added and/ or removed from each release.

In the end we bumped the version down to 3.5.7, which was the version we used on the smaller project, Even though we can't find anything describing the contents of the release.

Possible fix

Release notes describing atleast every major release should be added

_Example of some other github project release notes_

JamesNk/Json.Net

https://github.com/JamesNK/Newtonsoft.Json/releases

dotnetcore/CAP

https://github.com/dotnetcore/CAP/releases

Powershell/Powershell

https://github.com/PowerShell/PowerShell/releases

documentation

Most helpful comment

Wrote some short notes, honestly I've never done this well, so I can't promise anything better in the future. Help is always welcome, if someone can write and ask me the details of each commit to prepare the notes. Otherwise, I doubt the experience will change. It's an open source project, and I'm the majority contributor. I don't do well writing release notes, sorry.

Edit: Clicked wrong button, didn't mean to close it.

All 2 comments

Wrote some short notes, honestly I've never done this well, so I can't promise anything better in the future. Help is always welcome, if someone can write and ask me the details of each commit to prepare the notes. Otherwise, I doubt the experience will change. It's an open source project, and I'm the majority contributor. I don't do well writing release notes, sorry.

Edit: Clicked wrong button, didn't mean to close it.

Thanks! The release notes are really useful.

I find it hard to write release notes all at once. Instead I keep a release-notes.md file in the repo (see example), and add a note whenever I commit changes that users would want to know about. Then I just need to tidy the list when I release. Not sure if that'd work better for you, just an idea to consider.

Was this page helpful?
0 / 5 - 0 ratings