diff --git a/newsfragments/README.md b/newsfragments/README.md index 7b233a150f..f121f4823c 100644 --- a/newsfragments/README.md +++ b/newsfragments/README.md @@ -5,15 +5,17 @@ release notes. This should be a description of aspects of the change commit message and PR description, which are a description of the change as relevant to people working on the code itself.) - Each file should be named like `..rst`, where +Each file should be named like `..rst`, where `` is an issue number, and `` is one of: * `feature` * `bugfix` +* `performance` * `doc` +* `internal` +* `removal` * `misc` -* `breaking-change` -* `deprecation` +* `breaking` So for example: `123.feature.rst`, `456.bugfix.rst` @@ -22,5 +24,5 @@ then open up the PR first and use the PR number for the newsfragment. Note that the `towncrier` tool will automatically reflow your text, so don't try to do any fancy formatting. Run -`towncrier --draft` to get a preview of what the release notes entry +`towncrier build --draft` to get a preview of what the release notes entry will look like in the final release notes. diff --git a/newsfragments/validate_files.py b/newsfragments/validate_files.py index 391483249c..23e4874454 100755 --- a/newsfragments/validate_files.py +++ b/newsfragments/validate_files.py @@ -7,12 +7,14 @@ import sys ALLOWED_EXTENSIONS = { + '.breaking.rst', '.bugfix.rst', '.doc.rst', '.feature.rst', + '.internal.rst', '.misc.rst', - '.breaking-change.rst', - '.deprecation.rst', + '.performance.rst', + '.removal.rst', } ALLOWED_FILES = { diff --git a/pyproject.toml b/pyproject.toml index ee2b5f7d74..47b113ded9 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -7,34 +7,44 @@ title_format = "v{version} ({project_date})" [[tool.towncrier.type]] -directory = "breaking-change" -name="Breaking Changes" -showcontent=true +directory = "feature" +name = "Features" +showcontent = true [[tool.towncrier.type]] -directory = "deprecation" -name = "Deprecations" +directory = "bugfix" +name = "Bugfixes" showcontent = true [[tool.towncrier.type]] -directory = "bugfix" -name="Bugfixes" -showcontent=true +directory = "performance" +name = "Performance improvements" +showcontent = true [[tool.towncrier.type]] directory = "doc" -name="Documentation Updates" -showcontent=true +name = "Improved Documentation" +showcontent = true [[tool.towncrier.type]] -directory = "feature" -name="Features" -showcontent=true +directory = "removal" +name = "Deprecations and Removals" +showcontent = true + +[[tool.towncrier.type]] +directory = "internal" +name = "Internal Changes - for Contributors" +showcontent = true [[tool.towncrier.type]] directory = "misc" -name="Misc" -showcontent=false +name = "Miscellaneous changes" +showcontent = false + +[[tool.towncrier.type]] +directory = "breaking" +name = "Breaking changes" +showcontent = true [tool.isort] profile="black"