From eac7d2a5ff89ace601a20a66aa3658bbcba5315b Mon Sep 17 00:00:00 2001 From: kclowes Date: Wed, 9 Feb 2022 14:32:40 -0700 Subject: [PATCH 1/3] Add 'Breaking Change' and 'Deprecation' to our valid newsfragment types --- newsfragments/validate_files.py | 2 ++ pyproject.toml | 10 ++++++++++ 2 files changed, 12 insertions(+) diff --git a/newsfragments/validate_files.py b/newsfragments/validate_files.py index ba3bae96b2..29d895e77a 100755 --- a/newsfragments/validate_files.py +++ b/newsfragments/validate_files.py @@ -12,6 +12,8 @@ '.feature.rst', '.misc.rst', '.removal.rst', + '.breaking-change.rst', + '.deprecation.rst', } ALLOWED_FILES = { diff --git a/pyproject.toml b/pyproject.toml index 97533d0116..804cc73713 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -5,3 +5,13 @@ underlines = ["-", "~", "^"] issue_format = "`#{issue} `__" title_format = "v{version} ({project_date})" + +[[tool.towncrier.type]] +directory = "breaking-change" +name="Breaking Changes" +showcontent=true + +[[tool.towncrier.type]] +directory = "deprecation" +name = "Deprecations" +showcontent = true From 6f5ba3287c8c2d1a6bd8f412021be630c66df769 Mon Sep 17 00:00:00 2001 From: kclowes Date: Wed, 9 Feb 2022 15:01:02 -0700 Subject: [PATCH 2/3] Add newsfragment for new newsfragment categories --- newsfragments/2340.feature.rst | 1 + 1 file changed, 1 insertion(+) create mode 100644 newsfragments/2340.feature.rst diff --git a/newsfragments/2340.feature.rst b/newsfragments/2340.feature.rst new file mode 100644 index 0000000000..208a28c40d --- /dev/null +++ b/newsfragments/2340.feature.rst @@ -0,0 +1 @@ +Added 'Breaking Changes' and 'Deprecations' categories to our release notes From fc4eee5d0b7c145b09c0008bcba824afb51eae57 Mon Sep 17 00:00:00 2001 From: kclowes Date: Thu, 10 Feb 2022 09:51:29 -0700 Subject: [PATCH 3/3] Remove removal section of release notes --- newsfragments/validate_files.py | 1 - 1 file changed, 1 deletion(-) diff --git a/newsfragments/validate_files.py b/newsfragments/validate_files.py index 29d895e77a..391483249c 100755 --- a/newsfragments/validate_files.py +++ b/newsfragments/validate_files.py @@ -11,7 +11,6 @@ '.doc.rst', '.feature.rst', '.misc.rst', - '.removal.rst', '.breaking-change.rst', '.deprecation.rst', }