aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/release-notes/config.yaml
diff options
context:
space:
mode:
authorEmma Foley <efoley@redhat.com>2021-08-12 12:43:39 +0100
committerEmma Foley <efoley@redhat.com>2021-08-12 13:27:30 +0100
commit8d8e43750e801b5c7abc2eadcba9f056635d7fdb (patch)
tree456a0ab7b0eef3f740cfc84abb7c1ce1926a1ed7 /docs/release/release-notes/config.yaml
parent0f8a84a598cbbead4939dbe85b00f722289b1662 (diff)
[docs][reno] Update reno to include template
The template for release notes wasn't conforming to the expected headings. A template was added to the config. To generate a new note (from the base directory in the repo), use:: reno --rel-notes-dir docs/release/release-notes/ new slug-goes-here The release notes are also included as part of the docs build, and the existing releases notes have been renamed accordingly. Signed-off-by: Emma Foley <efoley@redhat.com> Change-Id: I05d1950b37f266bb6eb3515b3660665cfd5c1d8b
Diffstat (limited to 'docs/release/release-notes/config.yaml')
-rw-r--r--docs/release/release-notes/config.yaml35
1 files changed, 35 insertions, 0 deletions
diff --git a/docs/release/release-notes/config.yaml b/docs/release/release-notes/config.yaml
index 5c2b7a7b..ae56f82d 100644
--- a/docs/release/release-notes/config.yaml
+++ b/docs/release/release-notes/config.yaml
@@ -1,3 +1,4 @@
+---
unreleased_version_title: 'Lakelse'
sections:
- [ features, New Features ]
@@ -15,3 +16,37 @@ branch_name_prefix: stable/
prelude_section_name: release_summary
stop_at_branch_base: False
collapse_pre_releases: False
+template: |
+ release_summary: >
+ Add a summary of the change here. All sections (including this one) are
+ optional, and if they are not needed, you can completely remove that section.
+ Each section is rendered separately, this mean you should assume each item
+ below is self-contained, and should not depend on info in any other section.
+ This means repetition is sometimes necessary, and this is okay.
+ features:
+ - |
+ List new features here
+ testing:
+ - |
+ List new testing notes here
+ docs:
+ - |
+ List documentation updates here
+ containers:
+ - |
+ List container updates here
+ ansible:
+ - |
+ List ansible playbook updates here
+ build:
+ - |
+ List build script updates here
+ fixes:
+ - |
+ List normal bug fixes here
+ deprecations:
+ - |
+ List deprecations here
+ other:
+ - |
+ List other notes here