'Unreleased' release notes show iBoot driver removed

Bug #1670401 reported by Ruby Loo on 2017-03-06
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ironic
Fix Released
Undecided
Jay Faulkner

Bug Description

Ironic's Current Series Release Notes (https://docs.openstack.org/releasenotes/ironic/unreleased.html) has a release note that was released in Ocata.

In the 'Upgrade Notes', it shows
    iBoot, Wake-On-LAN and AMT drivers are removed from ironic as they
    neither have nor are planning to have a third-party CI. They are still
    available from unsupported ironic driver collection in
    ironic-staging-drivers repository. If the ironic installation was
    using any driver based on those, the operator has to install
    ironic-staging-drivers and change the driver on affected nodes
    according to following correspondence list
    etc

That release note is from https://github.com/openstack/ironic/blob/master/releasenotes/notes/remove-iboot-wol-amt-27edaf109d28b663.yaml.

It was submitted on Dec 13, 2016. OH. I updated that release note on Feb 14 because it had an error in it. Is that why it is being shown on master?

Ruby Loo (rloo) on 2017-03-06
description: updated
Jay Faulkner (jason-oldos) wrote :

15:59:42 <JayF> dhellmann: Question: in Ironic, we updated a release note after ocata was cut, then backported it to stable/ocata. Now that release note shows up in master + in ocata release notes. What's the best way for us to fix?
16:00:11 <JayF> dhellmann: it's fairly important that we clean it up because it's the deprecation notice for removed drivers, so it's super confusing if it's in both places :/
16:00:56 <dhellmann> JayF: did you edit the note on master?
16:01:18 <dhellmann> JayF : you could revert the edit on master, I guess
16:01:26 <JayF> dhellmann: AIUI, commit was made to master (post ocata-cut) that edited the note for spelling/grammar/etc, then it was backported to stable/ocata
16:01:36 <dhellmann> yeah
16:01:47 <dhellmann> release note clean up may need to be an exception to the master-first rule
16:01:52 <JayF> Hmm. We might wanan talk to stable folks and get ^ yeah that
16:02:05 <-- Jeffrey4l (~Jeffrey@110.252.74.247) has quit (Ping timeout: 240 seconds)
16:02:06 <dhellmann> JayF : you could also try deleting the file on master
16:02:19 <JayF> I think my first shot will be reverting the update commit from master
16:02:33 <dhellmann> I think reverting the edit won't fix it, you'll just see the old text for the note on master
16:02:47 <JayF> that's what I'm afraid of, but I'd like to confirm that to be sure
16:02:51 <dhellmann> sure
16:02:56 <JayF> since deleting the file feels like a more extreme fix

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

Changed in ironic:
assignee: nobody → Jay Faulkner (jason-oldos)
status: New → In Progress
Jay Faulkner (jason-oldos) wrote :

Both potential fixes: https://review.openstack.org/#/c/442010/1 + https://review.openstack.org/442018

When tested locally, they appear to be making things worse: causing some ocata release notes to show up in master. Doug Helllman is helping troubleshoot in IRC.

Change abandoned by Jay Faulkner (<email address hidden>) on branch: master
Review: https://review.openstack.org/442010
Reason: This is not the preferred fix because if one day Reno starts complaining about notes with no recognized section (i.e. the original state of this release note), it would break our build. Instead we're fixing this with https://review.openstack.org/#/c/442018/ which completely removes the file from master.

Jay Faulkner (jason-oldos) wrote :

Ignore comment #3, I had a local build issue causing those problems. Both patches fixed the issue, but going with the one that deletes the note from master so that if Reno is fixed to complain for invalid release notes, it won't immediately break our build :).

Note that the release note does stay in place for the Ocata notes, despite being deleted in master, because it exists in the fixed form in stable/ocata branch.

Reviewed: https://review.openstack.org/442018
Committed: https://git.openstack.org/cgit/openstack/ironic/commit/?id=bb22ddd0561ddc35d8c25313b04e2a8be8513251
Submitter: Jenkins
Branch: master

commit bb22ddd0561ddc35d8c25313b04e2a8be8513251
Author: Jay Faulkner <email address hidden>
Date: Mon Mar 6 08:16:16 2017 -0800

    Delete release note to fix build

    This release note was updated in master after the ocata branch was cut.
    Doing this caused it to appear in both ocata and current-series release
    notes. Removing the file from master will prevent it from showing up in
    master anymore.

    Change-Id: Ic1c7ec1483e92e15a82392d87874c08a7a03b710
    Closes-bug: #1670401

Changed in ironic:
status: In Progress → Fix Released

This issue was fixed in the openstack/ironic 8.0.0 release.

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

Other bug subscribers