Skip to content

Commit f93336a

Browse files
authored
Add 'Breaking Changes' and 'Deprecation' to our valid newsfragment types (#2340)
* Add 'Breaking Change' and 'Deprecation' to our valid newsfragment types * Add newsfragment for new newsfragment categories * Remove removal section of release notes
1 parent 78e01cf commit f93336a

File tree

3 files changed

+13
-1
lines changed

3 files changed

+13
-1
lines changed

newsfragments/2340.feature.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Added 'Breaking Changes' and 'Deprecations' categories to our release notes

newsfragments/validate_files.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,8 @@
1111
'.doc.rst',
1212
'.feature.rst',
1313
'.misc.rst',
14-
'.removal.rst',
14+
'.breaking-change.rst',
15+
'.deprecation.rst',
1516
}
1617

1718
ALLOWED_FILES = {

pyproject.toml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,13 @@
55
underlines = ["-", "~", "^"]
66
issue_format = "`#{issue} <https://github.com/ethereum/web3.py/issues/{issue}>`__"
77
title_format = "v{version} ({project_date})"
8+
9+
[[tool.towncrier.type]]
10+
directory = "breaking-change"
11+
name="Breaking Changes"
12+
showcontent=true
13+
14+
[[tool.towncrier.type]]
15+
directory = "deprecation"
16+
name = "Deprecations"
17+
showcontent = true

0 commit comments

Comments
 (0)