openstack/deb-python-reno
Code Issues Proposed changes

Add deprecations section to release notes

Browse Source 
Change-Id: Idf848b370dd7598d38a3dfd8c13b0411769e42e4
This commit is contained in:
Graham Hayes
2015-11-19 17:52:54 +00:00
parent b243431998
commit ddec6c5bc7
3 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
releasenotes/notes/add-deprecations-section-6b0f118fe190585c.yaml Normal file
View File

@@ -0,0 +1,3 @@
---
features:
- Added a new section for deprecations that occur during a release

7
reno/create.py
View File

@@ -52,6 +52,13 @@ upgrade:
needs to be worded so that it does not depend on any needs to be worded so that it does not depend on any
information only available in another section, such information only available in another section, such
as the prelude. This may mean repeating some details. as the prelude. This may mean repeating some details.
deprecations:
- List deprecations notes here, or remove this section.
All of the list items in this section are combined
when the release notes are rendered, so the text
needs to be worded so that it does not depend on any
information only available in another section, such
as the prelude. This may mean repeating some details.
critical: critical:
- Add critical notes here, or remove this section. - Add critical notes here, or remove this section.
All of the list items in this section are combined All of the list items in this section are combined

1
reno/formatter.py
View File

@@ -21,6 +21,7 @@ _SECTION_ORDER = [
('features', 'New Features'), ('features', 'New Features'),
('issues', 'Known Issues'), ('issues', 'Known Issues'),
('upgrade', 'Upgrade Notes'), ('upgrade', 'Upgrade Notes'),
('deprecations', 'Deprecation Notes'),
('critical', 'Critical Issues'), ('critical', 'Critical Issues'),
('security', 'Security Issues'), ('security', 'Security Issues'),
('fixes', 'Bug Fixes'), ('fixes', 'Bug Fixes'),