openstack/ironic
Code Issues Proposed changes

Update FAQ about updates of release notes

Browse Source 
This updates the FAQ about how/when to update release notes.
In particular, it is now possible to update release notes for
intermediary releases that haven't yet been branched.

Change-Id: I90986e24d66ea9d183a255e0ac3b0f088e47c176
This commit is contained in:
Ruby Loo 2018-01-31 13:48:41 -05:00
parent eeeff800b3
commit 8492012e4b
1 changed files with 6 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
doc/source/contributor/faq.rst
View File

@ -79,22 +79,17 @@ For more information see the `reno documentation`_.
-------------------------
If this is a release note that pertains to something that was fixed on master
and has not yet been released, you can go ahead and update it by submitting
a patch.
or an intermediary release (during a development cycle, that hasn't been
branched yet), you can go ahead and update it by submitting a patch.
If it is the release note of an ironic release that has branched, it can be
updated but we will only allow it in extenuating circumstances. (It can be
If it is the release note of an ironic release that has branched, `it can be
updated
<https://docs.openstack.org/reno/latest/user/usage.html#updating-stable-branch-release-notes>`_
but we will only allow it in extenuating circumstances. (It can be
updated by *only* updating the file in that branch. DO NOT update the file
in master and cherry-pick it. If you do, `see how the mess was cleaned up
<https://bugs.launchpad.net/ironic/+bug/1670401>`_.)
If it is the release note of an intermediary ironic release (during a
development cycle), you cannot update it. (These show up in the
"Current Series Release Notes"). If you do update it, it will show up under
the current (unreleased) section, instead of under the intermediary release
section, because the date/time of that file being touched is newer than the
date/time of the tag associated with the intermediary release.
...get a decision on something?
-------------------------------