Merge #936

936: Implement towncrier for changelog updates r=mergify[bot] a=ionutfilip

## What type of PR?
Feature

## What does this PR do?
Implements towncrier to create changelog entries

### Related issue(s)

## Prerequistes
Before we can consider review and merge, please make sure the following list is done and checked.
If an entry in not applicable, you can check it or remove it from the list.

- [ ] In case of feature or enhancement: documentation updated accordingly
- [ ] Unless it's docs or a minor change: place entry in the [changelog](CHANGELOG.md), under the latest un-released version.


Co-authored-by: Ionut Filip <ionut.philip@gmail.com>

CHANGELOG.md

@@ -5,6 +5,8 @@ Notable changes to this project are documented in the current file. For more
 details about individual changes, see the Git log. You should read this before
 upgrading Freposte.io as some changes will include useful notes.
 
+<!-- TOWNCRIER -->
+
 v1.6.1 - unreleased
 -------------------
 - Enhancement: Make Unbound drop privileges after binding to port

PULL_REQUEST_TEMPLATE.md

@@ -13,4 +13,4 @@ Before we can consider review and merge, please make sure the following list is
 If an entry in not applicable, you can check it or remove it from the list.
 
 - [ ] In case of feature or enhancement: documentation updated accordingly
-- [ ] Unless it's docs or a minor change: place entry in the [changelog](CHANGELOG.md), under the latest un-released version.
+- [ ] Unless it's docs or a minor change: add [changelog](https://mailu.io/master/contributors/guide.html#changelog) entry file.

docs/contributors/guide.rst

@@ -69,6 +69,24 @@ After some testing on master, we will approve and merge this new PR as well.
 At the end of every milestone, a new stable branch will be created from ``master``
 or any previous commit that matches the completion of the milestone.
 
+CHANGELOG
+`````````
+
+Adding entries in the CHANGELOG is an automated process which requires creation of a file under
+``towncrier/newsfragments`` directory.
+
+The start of the filename is the ticket number, and the content is what will end up in the news file.
+For example, if ticket ``#850`` is about adding a new widget, the filename would be towncrier/newsfragments/850.feature
+and the content would be ``Feature that has just been added``.
+
+Supported file extensions are:
+
+- ``.feature``: Signifying a new feature.
+- ``.bugfix``: Signifying a bug fix.
+- ``.doc``: Signifying a documentation improvement.
+- ``.removal``: Signifying a deprecation or removal of public API.
+- ``.misc``: A ticket has been closed, but it is not of interest to users.
+
 Forked projects
 ---------------
 

pyproject.toml

@@ -0,0 +1,9 @@
+[tool.towncrier]
+    #package = "mypackage"
+    package_dir = "towncrier"
+    filename = "CHANGELOG.md"
+    underlines = ["-", "", ""]
+    template = "towncrier/template.md"
+    title_format = "v{version} - {project_date}"
+    issue_format = "[#{issue}](https://github.com/Mailu/Mailu/issues/{issue})"
+    start_string = "<!-- TOWNCRIER -->"

towncrier/template.md

@@ -0,0 +1,32 @@
+{% for section, _ in sections.items() %}
+{% set underline = underlines[0] %}{% if section %}{{section}}
+{{ underline * section|length }}{% set underline = underlines[1] %}
+
+{% endif %}
+
+{% if sections[section] %}
+{% for category, val in definitions.items() if category in sections[section]%}
+{{ definitions[category]['name'] }}
+{{ underline * definitions[category]['name']|length }}
+{% if definitions[category]['showcontent'] %}
+{% for text, values in sections[section][category].items() %}
+- {{ text }} ({{ values|join(', ') }})
+{% 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 %}