From 24e70e902bf189ad84ef97018156485ca4935277 Mon Sep 17 00:00:00 2001 From: Tom Schraitle Date: Sat, 26 Nov 2022 11:59:49 +0100 Subject: [PATCH] Fix #374: Adapt pyproject.tom for Towncrier * Replace the old, deprecated ``[[tool.towncrier.type]]`` entries with ``[tool.towncrier.fragment.]``. Described in https://towncrier.readthedocs.io/en/stable/configuration.html#deprecated-defining-custom-fragment-types-with-an-array-of-toml-tables * Add a changelog news file Co-authored-by: Nagidal --- changelog.d/374.bugfix.rst | 3 +++ pyproject.toml | 46 ++++++++++++-------------------------- 2 files changed, 17 insertions(+), 32 deletions(-) create mode 100644 changelog.d/374.bugfix.rst diff --git a/changelog.d/374.bugfix.rst b/changelog.d/374.bugfix.rst new file mode 100644 index 00000000..fd4e7ea4 --- /dev/null +++ b/changelog.d/374.bugfix.rst @@ -0,0 +1,3 @@ +Correct Towncrier's config entries in the :file:`pyproject.toml` file. +The old entries ``[[tool.towncrier.type]]`` are deprecated and need +to be replaced by ``[tool.towncrier.fragment.]``. diff --git a/pyproject.toml b/pyproject.toml index ba4be51b..03e4873a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -40,42 +40,24 @@ template = "changelog.d/_template.rst" # issue_format = "`#{issue} `_" # issue_format = ":gh:`{issue}`" - # [[tool.towncrier.type]] - # directory = "breaking" - # name = "Breaking Changes" - # showcontent = true - [[tool.towncrier.type]] - directory = "deprecation" - name = "Deprecations" - showcontent = true +[tool.towncrier.fragment.breaking] +name = "Breaking Changes" - [[tool.towncrier.type]] - directory = "feature" - name = "Features" - showcontent = true +[tool.towncrier.fragment.bugfix] +name = "Bug fixes" - # [[tool.towncrier.type]] - # directory = "improvement" - # name = "Improvements" - # showcontent = true +[tool.towncrier.fragment.deprecation] +name = "Deprecations" - [[tool.towncrier.type]] - directory = "bugfix" - name = "Bug Fixes" - showcontent = true +[tool.towncrier.fragment.doc] +name = "Improved documentation" - [[tool.towncrier.type]] - directory = "doc" - name = "Improved Documentation" - showcontent = true +[tool.towncrier.fragment.feature] +name = "Features" - [[tool.towncrier.type]] - directory = "trivial" - name = "Trivial/Internal Changes" - showcontent = true +[tool.towncrier.fragment.removal] +name = "Removals" - [[tool.towncrier.type]] - directory = "removal" - name = "Removals" - showcontent = true +[tool.towncrier.fragment.trivial] +name = "Trivial/Internal Changes"