| Petr Michalec | 1af73a3 | 2017-07-11 13:09:41 +0200 | [diff] [blame^] | 1 | --- |
| 2 | # Usage: |
| 3 | # |
| 4 | # reno -qd .releasenotes list |
| 5 | # reno -qd .releasenotes new slug-title --edit |
| 6 | # reno -qd .releasenotes report --no-show-source |
| 7 | |
| 8 | # Change prelude_section_name to 'summary' from default value prelude |
| 9 | prelude_section_name: summary |
| 10 | show_source: False |
| 11 | sections: |
| 12 | - [features, New Features] |
| 13 | - [upgrade, Upgrade Notes] |
| 14 | - [fixes, Bug Fixes] |
| 15 | - [other, Other Notes] |
| 16 | template: | |
| 17 | --- |
| 18 | # Author the following sections or remove the section if it is not related. |
| 19 | # Use one release note per a feature. |
| 20 | # |
| 21 | # If you miss a section from the list below, please first submit a review |
| 22 | # adding it to .releasenotes/config.yaml. |
| 23 | # |
| 24 | summary: > |
| 25 | This section is not mandatory. Use it to highlight the change. |
| 26 | |
| 27 | features: |
| 28 | - Use list to record summary of features. |
| 29 | - | |
| 30 | Provide detailed description with examples. |
| 31 | Format with reStructuredText. |
| 32 | |
| 33 | .. code-block:: text |
| 34 | |
| 35 | provide model/formula pillar snippets |
| 36 | |
| 37 | upgrade: |
| 38 | - | |
| 39 | Document how to use a feature and related upgrade instructions. |
| 40 | |
| 41 | fixes: |
| 42 | - Use list to record summary of fixes. |
| 43 | Quick and dirty `git log --oneline`. |
| 44 | |
| 45 | other: |
| 46 | - Author additional notes for the release. |
| 47 | - Format with reStructuredText. |
| 48 | - | |
| 49 | Use this section if note is not related to one of the common sections: |
| 50 | features, issues, upgrade, deprecations, security, fixes, api, cli |
| 51 | |
| 52 | * list item 1 |
| 53 | * list item 2 |
| 54 | |
| 55 | .. code-block:: yaml |
| 56 | |
| 57 | classes: |
| 58 | - system.class.to.load |