diff options
| author |   Emma Foley <efoley@redhat.com> | 2021-07-05 16:40:23 +0100 |
|---|---|---|
| committer | Emma Foley <efoley@redhat.com> | 2021-07-14 17:14:30 +0100 |
| commit | 0f8a84a598cbbead4939dbe85b00f722289b1662 (patch) | |
| tree | 2f7352d3c5fb18f2331a84fddfe081599d2faf43 | |
| parent | 283d8a7c2a4d193ef059f993140e0075c6494ac1 (diff) | |
[docs] Add reno to help in creating release notes
Reno[1] is used to create release notes. It can be used in conjunction
with sphinx to automatically create and publish release notes. In this
case it is being added to help with release notes collation at the end of
the release cycle.
There is a possibility that it can be more fully integrated later, if
there is need for it.
For the moment, release notes can be outputted using tox::
tox -e docs-releasenotes
Release notes can be added to features using::
reno new slug-goes-here
where slug-goes-here is combined with a random suffic to create a unique
name for the release note.
[1] https://docs.openstack.org/reno/latest/
Change-Id: Id7f113fa4817585bb429503ff3491c633a4ce8e2
Signed-off-by: Emma Foley <efoley@redhat.com>
| -rw-r--r-- | docs/release/release-notes/config.yaml | 17 | ||||
| -rw-r--r-- | docs/release/release-notes/notes/.placeholder | 0 | ||||
| -rw-r--r-- | docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml | 4 | ||||
| -rw-r--r-- | docs/requirements.txt | 1 | ||||
| -rw-r--r-- | tox.ini | 5 |
5 files changed, 27 insertions, 0 deletions
diff --git a/docs/release/release-notes/config.yaml b/docs/release/release-notes/config.yaml new file mode 100644 index 00000000..5c2b7a7b --- /dev/null +++ b/docs/release/release-notes/config.yaml @@ -0,0 +1,17 @@ +unreleased_version_title: 'Lakelse' +sections: + - [ features, New Features ] + - [ testing, Testing Notes ] + - [ docs, Documentation Updates ] + - [ containers, Container updates ] + - [ ansible, Ansible playbook updates ] + - [ build, Build script updates ] + - [ fixes, Normal Bug Fixes ] + - [ deprecations, Deprecations ] + - [ other, Other Notes ] + +branch_name_prefix: stable/ +#release_tag_re: opnfv-((?:v?[\d.ab]|rc)+) +prelude_section_name: release_summary +stop_at_branch_base: False +collapse_pre_releases: False diff --git a/docs/release/release-notes/notes/.placeholder b/docs/release/release-notes/notes/.placeholder new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/docs/release/release-notes/notes/.placeholder diff --git a/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml b/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml new file mode 100644 index 00000000..4dbf2e88 --- /dev/null +++ b/docs/release/release-notes/notes/add-reno-12eb20e3448b663b.yaml @@ -0,0 +1,4 @@ +--- +other: + - | + Add reno and corresponding tox jobs to make compiling release notes easier diff --git a/docs/requirements.txt b/docs/requirements.txt index 9fde2df2..dfa44583 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,3 @@ lfdocs-conf sphinx_opnfv_theme +reno @@ -17,3 +17,8 @@ whitelist_externals = echo basepython = python3 deps = -rdocs/requirements.txt commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./docs/ {toxinidir}/docs/_build/linkcheck + +[testenv:docs-releasenotes] +basepython=python3 +deps = -rdocs/requirements.txt +commands = reno --rel-notes-dir docs/release/release-notes/ report |