esapi-java-legacy icon indicating copy to clipboard operation
esapi-java-legacy copied to clipboard

Add release notes to the GitHub Releases

Open GitMensch opened this issue 5 years ago • 1 comments

After searching some minutes I've found the release notes to be part of documentation (I've looked there at second place but still did not found them because looking for a Changelog file, came back to this when checking the commits in the 2.2-tag).

It would still be much more nice to have this information in the release page, too, ideally with some nice formatting. See another release page to get the idea.

Note: this is not possible to be done via PR, it must be done by someone who has direct access to this repository.

If you don't want to do the work I'd be available to do it (and could be removed from the developer list afterwards). I offer to take care for the versions 2.1, 2.1.0.1, 2.2.0.0 (as I did not found reasonable notes for other versions).

GitMensch avatar Oct 24 '19 13:10 GitMensch

Changelog files are only as good as the commit logs and more often than not, those are either too detailed or not detailed or enough and anyone who is proficient with Git can generate one on there own. (I'm not sure, but I think even running 'mvn site' may generate a Changelog file already.) In general, I find Changelog files less than useful, so for that reason, I have always created separate 'release notes' under the 'documentation' directory. We then reference that when we announce a new release, and it is announced in various places (the two ESAPI Google groups, the OWASP Connector, on Twitter, etc.)

However, next time I will try to remember to create a comment to refer to release notes file in the next point release If you want to do that for these existing releases, drop me an email to my Gmail or OWASP account and let me know what permissions are needed for that and I'll discuss it with @xeno6696 and get back to you.

kwwall avatar Nov 18 '19 00:11 kwwall