From 6d5f6b4dff70825940eb67e7595cf20ae9287b37 Mon Sep 17 00:00:00 2001 From: Georg Krause Date: Fri, 2 Jul 2021 19:04:47 +0200 Subject: [PATCH] Add needed information for towncrier --- changes/changelog.d/.gitkeep | 0 changes/template.rst | 29 ++++++++++++++++++++++++ pyproject.toml | 43 ++++++++++++++++++++++++++++++++++++ 3 files changed, 72 insertions(+) create mode 100644 changes/changelog.d/.gitkeep create mode 100644 changes/template.rst create mode 100644 pyproject.toml diff --git a/changes/changelog.d/.gitkeep b/changes/changelog.d/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/changes/template.rst b/changes/template.rst new file mode 100644 index 0000000..cadfdef --- /dev/null +++ b/changes/template.rst @@ -0,0 +1,29 @@ + +{% for section, _ in sections.items() %} +{% if sections[section] %} +{% for category, val in definitions.items() if category in sections[section]%} +{{ definitions[category]['name'] }}: + +{% if definitions[category]['showcontent'] %} +{% for text in sections[section][category].keys()|sort() %} +- {{ text }} +{% 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 %} + diff --git a/pyproject.toml b/pyproject.toml new file mode 100644 index 0000000..68682d2 --- /dev/null +++ b/pyproject.toml @@ -0,0 +1,43 @@ +[tool.towncrier] + package = "changes" + package_dir = "" + filename = "CHANGELOG" + directory = "changes/changelog.d/" + start_string = ".. towncrier\n" + template = "changes/template.rst" + issue_format = "" + title_format = "{version} (unreleased)" + underlines = "-" + + [[tool.towncrier.section]] + path = "" + + [[tool.towncrier.type]] + directory = "feature" + name = "Features" + showcontent = true + + [[tool.towncrier.type]] + directory = "enhancement" + name = "Enhancements" + showcontent = true + + [[tool.towncrier.type]] + directory = "bugfix" + name = "Bugfixes" + showcontent = true + + [[tool.towncrier.type]] + directory = "doc" + name = "Documentation" + showcontent = true + + [[tool.towncrier.type]] + directory = "i18n" + name = "i18n" + showcontent = true + + [[tool.towncrier.type]] + directory = "misc" + name = "Other" + showcontent = true