Adopt towncrier for managing changelog. Fixes #83.

Renamed CHANGES.rst to NEWS.rst to align with towncrier defaults.
jaraco · Jun 21, 2023 · e5e26a7 · e5e26a7
1 parent 241541c
commit e5e26a7
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 2 deletions.
diff --git a/CHANGES.rst → NEWS.rst b/CHANGES.rst → NEWS.rst
diff --git a/docs/conf.py b/docs/conf.py
@@ -9,7 +9,7 @@
 # Link dates and other references in the changelog
 extensions += ['rst.linker']
 link_files = {
-    '../CHANGES.rst': dict(
+    '../NEWS.rst': dict(
         using=dict(GH='https://github.com'),
         replace=[
             dict(

diff --git a/docs/history.rst b/docs/history.rst
@@ -5,4 +5,4 @@
 History
 *******
 
-.. include:: ../CHANGES (links).rst
+.. include:: ../NEWS (links).rst
diff --git a/towncrier.toml b/towncrier.toml
@@ -0,0 +1,2 @@
+[tool.towncrier]
+title_format = "{version}"
diff --git a/tox.ini b/tox.ini
@@ -25,6 +25,15 @@ commands =
 	python -m sphinx -W --keep-going . {toxinidir}/build/html
 	python -m sphinxlint
 
+[testenv:finalize]
+skip_install = True
+deps =
+	towncrier
+	jaraco.develop
+passenv = *
+commands =
+	python -m jaraco.develop.towncrier build
+
 [testenv:release]
 skip_install = True
 deps =
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,4 +5,4 @@ @@
     History
     *******
-    .. include:: ../CHANGES (links).rst
+    .. include:: ../NEWS (links).rst