Merge pull request #2399 from webknjaz/maintenance/towncrier-categories

📝 Enable showing news categories in towncrier log
pypa · Oct 17, 2020 · 893d815 · 893d815
2 parents 0ce0715 + a278b0f
commit 893d815
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/changelog.d/2394.doc.rst b/changelog.d/2394.doc.rst
@@ -0,0 +1,3 @@
+Extended towncrier news template to include change note categories.
+This allows to see what types of changes a given version introduces
+-- by :user:`webknjaz`
diff --git a/pyproject.toml b/pyproject.toml
@@ -15,7 +15,7 @@ backend-path = ["."]
     title_format = "v{version}"
     issue_format = "#{issue}"
     template = "towncrier_template.rst"
-    underlines = ["-"]
+    underlines = ["-", "^"]
 
     [[tool.towncrier.type]]
         directory = "deprecation"

diff --git a/towncrier_template.rst b/towncrier_template.rst
@@ -1,10 +1,14 @@
 {% 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() %}
 * {{ values|join(', ') }}: {{ text }}