ci: Adopt towncrier to auto-generate changelog

.pre-commit-config.yaml

@@ -36,3 +36,7 @@ repos:
     - yaml
     args:
     - --strict
+- repo: https://github.com/twisted/towncrier
+  rev: 23.6.0
+  hooks:
+  - id: towncrier-check

CHANGES.rst

@@ -1,42 +1,44 @@
 CHANGES
 =======
 
-0.5.0 (undefined)
------------------
+.. towncrier release notes start
 
-* Fix a regression in Python 3.10 due to #10 (#11)
+0.5.0 (2023-07-21)
+------------------
+
+* Fix a regression in Python 3.10 due to #10 (`#11 <https://github.com/aio-libs/aiomonitor/issues/11>`_)
 
-* Support Python 3.11 properly by allowing the optional `name` and `context` kwargs passed to `asyncio.create_task()` in the hooked task factory function (#10)
+* Support Python 3.11 properly by allowing the optional (`name` and `context` kwargs passed to `asyncio.create_task()` in the hooked task factory function `#10 <https://github.com/aio-libs/aiomonitor/issues/10>`_)
 
 * Update development dependencies
 
-* Selective persistent termination logs (#9)
+* Selective persistent termination logs (`#9 <https://github.com/aio-libs/aiomonitor/issues/9>`_)
 
-* Implement cancellation chain tracker (#8)
+* Implement cancellation chain tracker (`#8 <https://github.com/aio-libs/aiomonitor/issues/8>`_)
 
 * Trigger auto-completion only when Tab is pressed
 
-* Support auto-completion of commands and arguments (#7)
+* Support auto-completion of commands and arguments (`#7 <https://github.com/aio-libs/aiomonitor/issues/7>`_)
 
 * Add missing explicit dependency to Click
 
 * Promote `console_locals` as public attr
 
-* Reimplement console command (#6)
+* Reimplement console command (`#6 <https://github.com/aio-libs/aiomonitor/issues/6>`_)
 
-* Migrate to Click-based command line interface (#5)
+* Migrate to Click-based command line interface (`#5 <https://github.com/aio-libs/aiomonitor/issues/5>`_)
 
-* Adopt `prompt_toolkit` and support concurrent clients (#4)
+* Adopt (`prompt_toolkit` and support concurrent clients `#4 <https://github.com/aio-libs/aiomonitor/issues/4>`_)
 
-* Show the total number of tasks when executing `ps` (#3)
+* Show the total number of tasks when executing (`ps` `#3 <https://github.com/aio-libs/aiomonitor/issues/3>`_)
 
 * Apply black, isort, mypy, flake8 and automate CI workflows using GitHub Actions
 
 * Fix the task creation location in the 'ps' command output
 
-* Remove loop=loop from all asynchronous calls to support newer Python versions (#329)
+* Remove loop=loop from all asynchronous calls to support newer Python versions (`#329 <https://github.com/aio-libs/aiomonitor/issues/329>`_)
 
-* Added the task creation stack chain display to the 'where' command by setting a custom task factory (#1)
+* Added the task creation stack chain display to the 'where' command by setting a custom task factory (`#1 <https://github.com/aio-libs/aiomonitor/issues/1>`_)
 
 These are the backported changes from [aiomonitor-ng](https://github.com/achimnol/aiomonitor-ng).
 As the version bumps have gone far away in the fork, all those extra releases are squashed into the v0.5.0 release.

changes/375.misc.md

@@ -0,0 +1 @@
+Adopt towncrier to auto-generate the changelog

changes/template.rst

@@ -0,0 +1,26 @@
+{# TOWNCRIER TEMPLATE #}
+{% for section, _ in sections.items() %}
+
+{% if sections[section] %}
+{% for category, val in definitions.items() if category in sections[section]%}
+{% if definitions[category]['showcontent'] %}
+{% for text, values in sections[section][category].items() %}
+- {{ text }}
+  {{ values|join(',\n  ') + '\n' }}
+{% endfor %}
+
+{% else %}
+- {{ sections[section][category]['']|join(', ') }}
+
+{% endif %}
+{% if sections[section][category]|length == 0 %}
+No significant changes.
+
+{% else %}
+{% endif %}
+
+{% endfor %}
+{% else %}
+No significant changes.
+{% endif %}
+{% endfor %}

pyproject.toml

@@ -14,3 +14,12 @@ line_length = 88
 
 [tool.mypy]
 ignore_missing_imports = true
+
+[tool.towncrier]
+package = "aiomonitor"
+filename = "CHANGES.rst"
+directory = "changes/"
+title_format = "{version} ({project_date})"
+template = "changes/template.rst"
+underlines = ["-", "~", "^"]
+issue_format = "(`#{issue} <https://github.com/aio-libs/aiomonitor/issues/{issue}>`_)"