Relnotes for Pike contains an entry from a past release

Bug #1708560 reported by Akihiro Motoki
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
neutron
Fix Released
High
Akihiro Motoki

Bug Description

https://docs.openstack.org/releasenotes/neutron/unreleased.html contains an entry "vlan-aware-vms" but this is a feature from Ocata. This regression happened because we touched a release note from a past release in the master branch. It happened during URL update in the doc-migration work. Release notes from past releases should not be touched.

The solution for this is to use 'ignore-notes' directive option from reno. This is available since reno 2.5.0.
Note that reverting the patch does not solve the problem as reno still considers a relnote updated in the master branch

This bug tracker is for errors with the documentation, use the following as a template and remove or add fields as you see fit. Convert [ ] into [x] to check boxes:

- [X] This doc is inaccurate in this way: ______
- [ ] This is a doc addition request.
- [ ] I have a fix to the document that I can paste below including example: input and output.

If you have a troubleshooting or support issue, use the following resources:

 - Ask OpenStack: http://ask.openstack.org
 - The mailing list: http://lists.openstack.org
 - IRC: 'openstack' channel on Freenode

-----------------------------------
Release: 11.0.0.0b4.dev37 on 2017-08-03 22:11
SHA: 8f79a92e45c84819cfc4d1cda99c9320ae78bbaf
Source: https://git.openstack.org/cgit/openstack/neutron/tree/doc/source/unreleased.rst
URL: https://docs.openstack.org/releasenotes/neutron/unreleased.html

Tags: doc
Akihiro Motoki (amotoki)
Changed in neutron:
importance: Undecided → High
Revision history for this message
YAMAMOTO Takashi (yamamoto) wrote :

this seems like the same problem as bug 1682776.

i thought reno was supposed to handle updates of release notes. isn't it the case?

Changed in neutron:
status: New → Confirmed
Revision history for this message
Akihiro Motoki (amotoki) wrote :

If you update a release note, the release note is considered as part of a release which a last commit belongs to. This is what we have now.

horizon release notes has the similar problem during doc-migration and a fix is here: https://review.openstack.org/#/c/490250/

FYI > yamamoto

Revision history for this message
YAMAMOTO Takashi (yamamoto) wrote :

@Akihiro

i somehow thought that reno was supposed to figure out which version a note belongs to, by looking at when it was added.
but looking at reno source code, it doesn't seem like the case.
thank you for pointing out.

how did you generate the list of notes to ignore for the horizon patch?
i guess it can be done almost mechanically.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix proposed to neutron (master)

Fix proposed to branch: master
Review: https://review.openstack.org/490771

Changed in neutron:
status: Confirmed → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to neutron (master)

Reviewed: https://review.openstack.org/490771
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=6f1ecf24662b206e2ba580e8eb5fb6fcb551bf7e
Submitter: Jenkins
Branch: master

commit 6f1ecf24662b206e2ba580e8eb5fb6fcb551bf7e
Author: Akihiro Motoki <email address hidden>
Date: Fri Aug 4 07:14:21 2017 +0000

    Exclude relnote from past releases from Pike relnotes

    reno includes release notes touched in a target release
    even if they are added from past releases.
    The recent release note cleanup I made as part of doc8 adoption
    and some other cleanup touched release notes from past releases.
    As a result, we see several number of release notes from past
    release in the Pike release notes unexpectedly.

    Also adds a warning note to the release notes howto page

    Change-Id: I127f96896488e9992d9309d76055b4883f6a62f3
    Closes-Bug: #1708560

Changed in neutron:
status: In Progress → Fix Released
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix included in openstack/neutron 11.0.0.0rc1

This issue was fixed in the openstack/neutron 11.0.0.0rc1 release candidate.

Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix proposed to neutron (master)

Related fix proposed to branch: master
Review: https://review.openstack.org/493077

tags: added: neutron-proactive-backport-potential
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Related fix merged to neutron (master)

Reviewed: https://review.openstack.org/493077
Committed: https://git.openstack.org/cgit/openstack/neutron/commit/?id=daa1c85a3b84b6ee5bd127ea88e285d189b88979
Submitter: Jenkins
Branch: master

commit daa1c85a3b84b6ee5bd127ea88e285d189b88979
Author: YAMAMOTO Takashi <email address hidden>
Date: Sat Aug 12 01:42:42 2017 +0900

    releasenotes: Move Pike ignore-notes to a proper file

    Now unreleased.rst is for Queen.

    Related-Bug: #1708560
    Change-Id: Iaf6642c8955d68a1f6b6572d3ae2a3dabc1244df

tags: removed: neutron-proactive-backport-potential
tags: added: neutron-proactive-backport-potential
tags: removed: neutron-proactive-backport-potential
Revision history for this message
Akihiro Motoki (amotoki) wrote :

I would like to leave a comment to clarify the situation.

The release notes page for **ALL RELEASES** published on docs.o.o are generated from the **RST** files in the master branch, so there is no need to backport the fix. (Note that files under releasenotes/notes in individual branches are looked up but RST files in non-master branches are never referred.)

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.