Add towncrier as a dev dependency and fix template

Signed-off-by: Aurélien Bompard <[email protected]>
fedora-infra · Jul 21, 2021 · 9caefe9 · 9caefe9
1 parent d2b8bfa
commit 9caefe9
Show file tree

Hide file tree

Showing 4 changed files with 42 additions and 36 deletions.
diff --git a/docs/contributing.rst b/docs/contributing.rst
@@ -196,7 +196,7 @@ When cutting a new release, follow these steps:
 #. Run ``poetry install`` to update the version in the metadata
 #. Add missing authors to the release notes fragments by changing to the ``news`` directory and
    running the ``get-authors.py`` script, but check for duplicates and errors
-#. Generate the release notes by running ``towncrier`` (in the base directory)
+#. Generate the release notes by running ``poetry run towncrier`` (in the base directory)
 #. Adjust the release notes in ``docs/release_notes.rst``.
 #. Generate the docs with ``tox -e docs`` and check them in ``docs/_build/html``.
 #. Commit the changes

diff --git a/news/_template.rst.j2 b/news/_template.rst.j2
@@ -8,9 +8,11 @@
    {%- endif -%}
 {%- endmacro -%}
 
+{{ top_line }}
+{{ top_underline * ((top_line)|length)}}
+
 Released on {{ versiondata.date }}.
 This is a {major|feature|bugfix} release that adds [short summary].
-
 {% for section, _ in sections.items() %}
 {% set underline = underlines[0] %}{% if section %}{{section}}
 {{ underline * section|length }}{% set underline = underlines[1] %}

diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -69,6 +69,7 @@ isort = "^5.1.4"
 rstcheck = "^3.3.1"
 pre-commit = "^2.13.0"
 safety = "^1.10.3"
+towncrier = "^21.3.0"
 
 [tool.poetry.extras]
 deploy = ["gunicorn"]