diff options
author | Andreas Finkler <3929834+DudeNr33@users.noreply.github.com> | 2022-10-10 09:09:31 +0200 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-10-10 09:09:31 +0200 |
commit | 21fb32ec1f1d6090af21756ac66eb094acf84db5 (patch) | |
tree | e2e527fb6d0bcf68ede39aba24e865f82269e943 /towncrier.toml | |
parent | 0d62f67d86c482bd3703e0a75b0f4eb1c8b0e0ee (diff) | |
download | pylint-git-21fb32ec1f1d6090af21756ac66eb094acf84db5.tar.gz |
Add "breaking change" and "user action" fragment types (#7588)
Co-authored-by: Pierre Sassoulas <pierre.sassoulas@gmail.com>
Diffstat (limited to 'towncrier.toml')
-rw-r--r-- | towncrier.toml | 17 |
1 files changed, 14 insertions, 3 deletions
diff --git a/towncrier.toml b/towncrier.toml index b25b28298..89853e2b1 100644 --- a/towncrier.toml +++ b/towncrier.toml @@ -7,9 +7,20 @@ issue_format = "`#{issue} <https://github.com/PyCQA/pylint/issues/{issue}>`_" wrap = true # Definition of fragment types. -# TODO: with the next towncrier release (21.9.1) it will be possible to define -# custom types as toml tables: -# https://github.com/twisted/towncrier#further-options +# We want the changelog to show in the same order as the fragment types +# are defined here. Therefore we have to use the array-style fragment definition. +# The table-style definition, although more concise, would be sorted alphabetically. +# https://github.com/twisted/towncrier/issues/437 +[[tool.towncrier.type]] +directory = "breaking" +name = "Breaking Changes" +showcontent = true + +[[tool.towncrier.type]] +directory = "user_action" +name = "Changes requiring user actions" +showcontent = true + [[tool.towncrier.type]] directory = "new_check" name = "New Checks" |