#104 Investigate Methods for Release Notes Generation
Closed: Fixed None Opened 9 years ago by tflink.

One thing that we're currently missing is release notes. Instead of generating them by hand, it would be nice to have them done semi-automatically.

Ideally this would create rst that could be built with our documentation but a link to the git changelog would be acceptable if integrating the tool would take more than a couple hours.


I created a small project for this task. It's located here: https://bitbucket.org/Rorosha/releaselog

I think that your repo is missing some files. there are no templates there, which releaselog.py is looking for

If I symlink the releaselog.py into docs/, everything works as expected.

I think that the output formatting is lacking a bit, though. I'd prefer to have output that looks like [[http://tflink.fedorapeople.org/taskotron/initial-taskotron-docs/releasenotes.html|this example rendering]]. Once we set a standard commit message format, I also want to see tickets linked from the release notes using a variable phabricator baseurl.

I've pushed releaselog to pypi, so now you can pip install it. Once it's installed all we need to do is run releaselog from the docs directory and it'll generate notes from the latest tag to head. I'll get to updating the formatting to your format next.

I imagine this process will require some manual tuning for each release, but at least most of the leg work is done for gathering information on a release.

Since this is done, I'm closing it.

Login to comment on this ticket.

Metadata