From 2e22e2d0b64850ff03356a9d52c06e79c23ef65f Mon Sep 17 00:00:00 2001 From: kclowes Date: Fri, 20 May 2022 14:12:01 -0600 Subject: [PATCH] Add breaking change type to newsfragment (#61) * Add breaking change type to newsfragment * Move breaking-change -> breaking --- newsfragments/README.md | 1 + newsfragments/validate_files.py | 1 + pyproject.toml | 5 +++++ 3 files changed, 7 insertions(+) diff --git a/newsfragments/README.md b/newsfragments/README.md index 09a10ddc..bcb0412a 100644 --- a/newsfragments/README.md +++ b/newsfragments/README.md @@ -15,6 +15,7 @@ Each file should be named like `..rst`, where * `internal` * `removal` * `misc` +* `breaking` So for example: `123.feature.rst`, `456.bugfix.rst` diff --git a/newsfragments/validate_files.py b/newsfragments/validate_files.py index c0e9b289..0a13ec2a 100755 --- a/newsfragments/validate_files.py +++ b/newsfragments/validate_files.py @@ -8,6 +8,7 @@ import pathlib import sys ALLOWED_EXTENSIONS = { + '.breaking.rst', '.bugfix.rst', '.doc.rst', '.feature.rst', diff --git a/pyproject.toml b/pyproject.toml index b03fe29e..31433140 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -41,3 +41,8 @@ showcontent = true directory = "misc" name = "Miscellaneous changes" showcontent = false + +[[tool.towncrier.type]] +directory = "breaking" +name = "Breaking changes" +showcontent = true