Skip to content

Commit

Permalink
configure reno
Browse files Browse the repository at this point in the history
The defaults for reno include sections and use cases we don't care
about for this project, so simplify the setup.

Signed-off-by: Doug Hellmann <[email protected]>
  • Loading branch information
dhellmann committed Aug 29, 2020
1 parent 0e08891 commit 4077a4c
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions reno.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
add_release_date: true
sections:
- ['features', 'New Features']
- ['fixes', 'Bug Fixes']
- ['upgrade', 'Upgrade Notes']
template: |
prelude: >
Replace this text with content to appear at the top of the section for this
release. All of the prelude content is merged together and then rendered
separately from the items listed in other parts of the file, so the text
needs to be worded so that both the prelude and the other items make sense
when read independently. This may mean repeating some details. Not every
release note requires a prelude. Usually only notes describing major
features or adding release theme details should have a prelude.
features:
- |
List new features 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.
upgrade:
- |
List upgrade 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.
fixes:
- |
Add normal bug fixes 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.

0 comments on commit 4077a4c

Please sign in to comment.