[openstack-dev] [release][reno] FAQ: Why is reno showing notes for released versions on the "unreleased.html" page?

Doug Hellmann doug at doughellmann.com
Wed Jun 8 20:12:39 UTC 2016

I've had several people notice recently that release notes on the
"unreleased.html" page are actually including notes from the mitaka
release. This is because of the instructions we're giving reno.

First, the "unreleased.rst" page is poorly named (my fault). It is
actually the "current" branch, as the title inside the rst file
indicates. The instructions given to reno via the directives in
that file tell it to scan the "current" branch, whatever that happens
to be.

We need it to do that to test the release notes build with a patch
under review, because while the patch is still under review it does
not live on any of the named branches (it's not on master until
it's merged into master, etc.). So, in order to ensure that new
release notes do not break the HTML build, we test them on this
special page.

As reno scans a branch, it looks for all versions visible down the
linear history of that branch. It happens that now our master
branches include multiple versions in their history with release
notes, and so reno reports all of them.

This may also occur on future stable branches, since the history
for stable/newton will include the version tagged to create the
branch for stable/mitaka.  If you would prefer that "newton.html"
page not include older versions, you can add the "earliest-version"
parameter to the release-notes directive to specify a version where
reno should stop. [1]

Setting the "earliest-version" on the page that scans the current
branch may result in notes being left out of the test build, so
please do not do that.


[1] http://docs.openstack.org/developer/reno/sphinxext.html#directive-release-notes

More information about the OpenStack-dev mailing list