simpleidserver / SimpleIdServer

OpenID, OAuth 2.0, SCIM2.0, UMA2.0, FAPI, CIBA & OPENBANKING Framework for ASP.NET Core
https://simpleidserver.com/
Apache License 2.0
683 stars 90 forks source link

Add CHANGELOG to repo and into GigHub Release notes #712

Closed LazaroOnline closed 4 weeks ago

LazaroOnline commented 3 months ago

As a SimpleIdServer user, when it comes to upgrading, I would much appreciate if the releases had a Changelog so I could see if there are breaking changes or what are the differences and be prepared for it without getting an unexpected surprise in production latter.

You can either have one or multiple Changelog.md files in the project and then add that into the github release description. It would also appreciated if those changes were separated by package or if it specified the packages affected, since my project uses just the "SimpleIdServer.Scim" package at the moment, so I would be able to read just the changes in SCIM.

Here are some changelog style examples:

simpleidserver commented 3 months ago

Indeed, we do not yet have documents listing the changes between different versions. However, starting from version 4.0.3, we have been listing all the tickets included in the various releases. For the upcoming releases, we will endeavor to produce release notes.

Projects : https://github.com/simpleidserver?query=is%3Aclosed&tab=projects