dotmesh-io / dotmesh

dotmesh (dm) is like git for your data volumes (databases, files etc) in Docker and Kubernetes
https://dotmesh.com
Apache License 2.0
539 stars 29 forks source link

Track release notes in this repo #424

Open alaric-dotmesh opened 6 years ago

alaric-dotmesh commented 6 years ago

As developers, we'd like our release notes tracked in version control, along with the versions they pertain to, so we can have a better understanding of (and ability to search...) the history of our product.

To do this, we could have a RELEASE.md file with headings for each release, and put the release notes in there. We can add to the top of the file as we develop stuff, and then we can then further automate the release process to feed the latest release's notes into Github and to add a heading for the actual release number we chose at the top of the file, thereby closing off the additions for that release.

alaric-dotmesh commented 6 years ago

Release 0.5.2 took ~45 minutes; a lot of that was due to having to poke at test flakes to get it passing, but it would be good to look more at manual steps in the release and automate them further.

Godley commented 6 years ago

Thoughts on autogenerating the release notes + release itself: Github allows you to do releases via git tag - we could have a script which:

There might also be some open source tool we can use to generate the changelog - previously used gitchangelog and other cli tools which pull out specific commits based on a regex.

Godley commented 6 years ago

This is moderately interesting - https://github.com/toolmantim/release-drafter/blob/master/README.md