Nova uses reno for providing release notes in-tree. That means that a patch can include a reno file or a series can have a follow-on change containing that file explaining what the impact is.
A reno file is a YAML file written in the releasenotes/notes
tree which
is generated using the reno tool this way:
$ tox -e venv -- reno new <name-your-file>
where usually <name-your-file>
can be bp-<blueprint_name>
for a
blueprint or bug-XXXXXX
for a bugfix.
Refer to the reno documentation for more information.
A release note is required anytime a reno section is needed. Below are some examples for each section. Any sections that would be blank should be left out of the note file entirely. If no section is needed, then you know you don’t need to provide a release note :-)
upgrade
security
features
critical
fixes
Three sections are left intentionally unexplained (prelude
, issues
and
other
). Those are targeted to be filled in close to the release time for
providing details about the soon-ish release. Don’t use them unless you know
exactly what you are doing.
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.