Setup towncrier to generate release notes

This commit is contained in:
Christoph Burgdorf
2019-07-29 12:51:01 +02:00
parent a6f6078814
commit 02fe35663c
11 changed files with 132 additions and 12 deletions

39
pyproject.toml Normal file
View File

@ -0,0 +1,39 @@
[tool.towncrier]
# Read https://github.com/ethereum/<REPO_NAME>/newsfragments/README.md for instructions
package = "<MODULE_NAME>"
filename = "docs/release_notes.rst"
directory = "newsfragments"
underlines = ["-", "~", "^"]
issue_format = "`#{issue} <https://github.com/ethereum/<REPO_NAME>/issues/{issue}>`__"
# Configure all default sections plus an extra one for performance improvements.
[[tool.towncrier.type]]
directory = "feature"
name = "Features"
showcontent = true
[[tool.towncrier.type]]
directory = "bugfix"
name = "Bugfixes"
showcontent = true
[[tool.towncrier.type]]
directory = "performance"
name = "Performance improvements"
showcontent = true
[[tool.towncrier.type]]
directory = "doc"
name = "Improved Documentation"
showcontent = true
[[tool.towncrier.type]]
directory = "removal"
name = "Deprecations and Removals"
showcontent = true
[[tool.towncrier.type]]
directory = "misc"
name = "Miscellaneous internal changes"
showcontent = false