[openstack-dev] [stable] [infra] How to auto-generate stable release notes

Thierry Carrez thierry at openstack.org
Mon Aug 3 12:57:39 UTC 2015


Hi everyone,

A month ago the stable branch team decided to move away from
synchronized stable point releases and enable continuous stable branch
delivery instead.

A side-effect of this decision is that we need to move away from a model
where we curate release notes for each stable point release, to a model
where stable release notes are automatically generated from the contents
of the git repository.

I see two options to make this work:

1. we can maintain a Changelog document directly in the source code.
Rather than being straightly backported from master, commits with
significant changes would be amended to additionally modify that document.

2. we come up with a keyword in commit messages ("ReleaseNotes:" ?) and
amend only the commit message of significant backports. Automation picks
up those and autogenerates a Release Notes document that gets included
in generated source code tarballs.

I was initially against option 1, because it's more difficult to
validate modified commits than straight backports from master. That
said, only a handful of commits are in this case, and it's still pretty
easy to check that the backport is sane (since the changelog is clearly
identifiable). So at this point it sounds much simpler than the alternative.

Thoughts ?

-- 
Thierry Carrez (ttx)



More information about the OpenStack-dev mailing list