update pyproject.toml to current template format and change newsfragm…

…ent type "doc" to "docs"
ethereum · May 15, 2023 · a7c3d39 · a7c3d39
1 parent 32bfc0d
commit a7c3d39
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 18 deletions.
diff --git a/newsfragments/2949.doc.rst → newsfragments/2949.docs.rst b/newsfragments/2949.doc.rst → newsfragments/2949.docs.rst
diff --git a/newsfragments/2953.doc.rst → newsfragments/2953.docs.rst b/newsfragments/2953.doc.rst → newsfragments/2953.docs.rst
diff --git a/newsfragments/2959.internal.rst b/newsfragments/2959.internal.rst
@@ -0,0 +1 @@
+Set towncrier settings in `pyproject.toml` to match the python project template and change newfragment type "doc" to "docs"
diff --git a/newsfragments/README.md b/newsfragments/README.md
@@ -12,7 +12,7 @@ Each file should be named like `<ISSUE>.<TYPE>.rst`, where
 * `bugfix`
 * `performance`
 * `deprecation`
-* `doc`
+* `docs`
 * `internal`
 * `removal`
 * `misc`

diff --git a/newsfragments/validate_files.py b/newsfragments/validate_files.py
@@ -10,7 +10,7 @@
     '.breaking.rst',
     '.bugfix.rst',
     '.deprecation.rst',
-    '.doc.rst',
+    '.docs.rst',
     '.feature.rst',
     '.internal.rst',
     '.misc.rst',

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,14 +1,15 @@
 [tool.towncrier]
-    package="web3"
-    filename = "docs/releases.rst"
-    directory = "newsfragments"
-    underlines = ["-", "~", "^"]
-    issue_format = "`#{issue} <https://github.com/ethereum/web3.py/issues/{issue}>`__"
-    title_format = "v{version} ({project_date})"
+# Read https://github.com/ethereum/<REPO_NAME>/blob/main/newsfragments/README.md for instructions
+package = "web3"
+filename = "docs/release_notes.rst"
+directory = "newsfragments"
+underlines = ["-", "~", "^"]
+title_format = "web3.py v{version} ({project_date})"
+issue_format = "`#{issue} <https://github.com/ethereum/web3.py/issues/{issue}>`__"
 
 [[tool.towncrier.type]]
-directory = "feature"
-name = "Features"
+directory = "breaking"
+name = "Breaking Changes"
 showcontent = true
 
 [[tool.towncrier.type]]
@@ -17,18 +18,18 @@ name = "Bugfixes"
 showcontent = true
 
 [[tool.towncrier.type]]
-directory = "performance"
-name = "Performance improvements"
+directory = "deprecation"
+name = "Deprecations"
 showcontent = true
 
 [[tool.towncrier.type]]
-directory = "doc"
+directory = "docs"
 name = "Improved Documentation"
 showcontent = true
 
 [[tool.towncrier.type]]
-directory = "removal"
-name = "Deprecations and Removals"
+directory = "feature"
+name = "Features"
 showcontent = true
 
 [[tool.towncrier.type]]
@@ -38,10 +39,15 @@ showcontent = true
 
 [[tool.towncrier.type]]
 directory = "misc"
-name = "Miscellaneous changes"
+name = "Miscellaneous Changes"
 showcontent = false
 
 [[tool.towncrier.type]]
-directory = "breaking"
-name = "Breaking changes"
+directory = "performance"
+name = "Performance Improvements"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "removal"
+name = "Removals"
 showcontent = true