p53209761
/
test_ok2
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Show "trivial" category in CHANGELOG 

I think it might sense to display in the CHANGELOG internal or
trivial changes because they might trip users between releases.

For example, a note about an internal refactoring (like
moving a class between modules) is useful for a user
that has been using the internal API. Of course
we are not breaking anything because it was an internal API, but no
reason not to save time for users who did use it.
This commit is contained in:
Bruno Oliveira 2017-06-23 12:30:29 -03:00
parent 22b7701431
commit 6de19ab7ba
2 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
changelog/_template.rst
View File

@ -6,7 +6,7 @@
{% endif %}
{% if sections[section] %}
{% for category, val in definitions.items() if category in sections[section] and category != 'trivial' %}
{% for category, val in definitions.items() if category in sections[section] %}
{{ definitions[category]['name'] }}
{{ underline * definitions[category]['name']|length }}

4
pyproject.toml
View File

@ -31,5 +31,5 @@ template = "changelog/_template.rst"
[[tool.towncrier.type]]
directory = "trivial"
name = "Trivial Changes"
showcontent = false
name = "Trivial/Internal Changes"
showcontent = true