| Filip Pytloun | 72cd397 | 2018-01-18 13:40:40 +0100 | [diff] [blame] | 1 | --- |
| 2 | # Usage: |
| 3 | # |
| 4 | # reno list |
| 5 | # reno new slug-title --edit |
| 6 | # reno 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 | # summary/prelude section is always included |
| 13 | - [features, New Features] |
| 14 | - [issues, Known Issues] |
| 15 | - [fixes, Bug Fixes] |
| 16 | - [other, Other Notes] |
| 17 | template: | |
| 18 | --- |
| 19 | # Author the following sections or remove the section if it is not related. |
| 20 | # Use one release note per a feature. |
| 21 | # |
| 22 | # If you miss a section from the list below, please first submit a review |
| 23 | # adding it to releasenotes/config.yaml. |
| 24 | # |
| 25 | summary: > |
| 26 | This section is not mandatory. Use it to highlight the change. |
| 27 | |
| 28 | features: |
| 29 | - Use list to record summary of features. |
| 30 | - | |
| 31 | Provide detailed description with examples. |
| 32 | Format with reStructuredText. |
| 33 | |
| 34 | .. code-block:: text |
| 35 | |
| 36 | provide model/formula pillar snippets |
| 37 | |
| 38 | issues: |
| 39 | - Use list to record known limitations. |
| 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 | formula: |
| 58 | example: |
| 59 | enabled: true |