[openstack-dev] [neutron] [release] misleading release notes

Doug Hellmann doug at doughellmann.com
Thu Feb 2 13:41:11 UTC 2017

Excerpts from Armando M.'s message of 2017-02-01 18:13:46 -0800:
> Hi,
> There is something puzzling about release notes. I don't see 8.0.0 [1], and
> it looks like features released in Mitaka are being advertised as Newton
> features [2]. For instance, [3] 'Agent availability zones' shows as a
> Newton feature when I am pretty positive that it went in Mitaka [4].
> I suspect what happens is that someone revises the content at a later date
> and reno associated the last timestamp of the release note with release
> where the change has been made?
> I don't see other projects' release notes broken this way so we must be
> doing something wrong. It would be good to have guidance from the release
> team.
> Thanks,
> Armando
> [1] http://docs.openstack.org/releasenotes/neutron/mitaka.html
> [2] http://docs.openstack.org/releasenotes/neutron/newton.html#id5
> [3] http://docs.openstack.org/releasenotes/neutron/newton.html#id6
> [4] https://review.openstack.org/#/c/204436/

The Ironic team pointed out a similar issue yesterday, and I
discovered a bug in the logic in reno to determine when a release
series had started. That bug has led to early releases in a series
that happen before a branch is created not being visible, so that,
combined with the logic for collapsing notes from pre-release
versions into the final release, is why 8.0.0 is missing.

I have a patch up for review now to fix this bug
(https://review.openstack.org/427842).  Testing the patch locally
with neutron's release notes show 8.0.0 on the mitaka page, as

Editing release notes is an important requirement for reno, and I
think that part is working correctly.  Reno works by scanning the
history of a branch from tip to root. It uses the content of the
most recent version of a note file (closest to tip) but places the
note in the release where the file was originally added (closes to

I could use some reviews on the patch above, but I'm reluctant to
ship a new version of reno while everyone is working on release
candidates this week. I'll plan for early next week, when breaking
the gate would be less disruptive.


More information about the OpenStack-dev mailing list