Skip to content

Commit 94b5c8d

Browse files
authored
update pyproject.toml to current template format and change newsfragment type "doc" to "docs" (ethereum#2959)
1 parent 32bfc0d commit 94b5c8d

File tree

6 files changed

+25
-18
lines changed

6 files changed

+25
-18
lines changed
File renamed without changes.
File renamed without changes.

newsfragments/2959.internal.rst

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Set towncrier settings in `pyproject.toml` to match the python project template and change newfragment type "doc" to "docs"

newsfragments/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Each file should be named like `<ISSUE>.<TYPE>.rst`, where
1212
* `bugfix`
1313
* `performance`
1414
* `deprecation`
15-
* `doc`
15+
* `docs`
1616
* `internal`
1717
* `removal`
1818
* `misc`

newsfragments/validate_files.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
'.breaking.rst',
1111
'.bugfix.rst',
1212
'.deprecation.rst',
13-
'.doc.rst',
13+
'.docs.rst',
1414
'.feature.rst',
1515
'.internal.rst',
1616
'.misc.rst',

pyproject.toml

+22-16
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
[tool.towncrier]
2-
package="web3"
3-
filename = "docs/releases.rst"
4-
directory = "newsfragments"
5-
underlines = ["-", "~", "^"]
6-
issue_format = "`#{issue} <https://github.com/ethereum/web3.py/issues/{issue}>`__"
7-
title_format = "v{version} ({project_date})"
2+
# Read https://github.com/ethereum/web3.py/blob/main/newsfragments/README.md for instructions
3+
package = "web3"
4+
filename = "docs/releases.rst"
5+
directory = "newsfragments"
6+
underlines = ["-", "~", "^"]
7+
title_format = "web3.py v{version} ({project_date})"
8+
issue_format = "`#{issue} <https://github.com/ethereum/web3.py/issues/{issue}>`__"
89

910
[[tool.towncrier.type]]
10-
directory = "feature"
11-
name = "Features"
11+
directory = "breaking"
12+
name = "Breaking Changes"
1213
showcontent = true
1314

1415
[[tool.towncrier.type]]
@@ -17,18 +18,18 @@ name = "Bugfixes"
1718
showcontent = true
1819

1920
[[tool.towncrier.type]]
20-
directory = "performance"
21-
name = "Performance improvements"
21+
directory = "deprecation"
22+
name = "Deprecations"
2223
showcontent = true
2324

2425
[[tool.towncrier.type]]
25-
directory = "doc"
26+
directory = "docs"
2627
name = "Improved Documentation"
2728
showcontent = true
2829

2930
[[tool.towncrier.type]]
30-
directory = "removal"
31-
name = "Deprecations and Removals"
31+
directory = "feature"
32+
name = "Features"
3233
showcontent = true
3334

3435
[[tool.towncrier.type]]
@@ -38,10 +39,15 @@ showcontent = true
3839

3940
[[tool.towncrier.type]]
4041
directory = "misc"
41-
name = "Miscellaneous changes"
42+
name = "Miscellaneous Changes"
4243
showcontent = false
4344

4445
[[tool.towncrier.type]]
45-
directory = "breaking"
46-
name = "Breaking changes"
46+
directory = "performance"
47+
name = "Performance Improvements"
48+
showcontent = true
49+
50+
[[tool.towncrier.type]]
51+
directory = "removal"
52+
name = "Removals"
4753
showcontent = true

0 commit comments

Comments
 (0)