📝💅 Split `trivial` change log category into 3
The new change note types are `packaging`, `contrib` and `misc`. `packaging` is intended for the audience of downstream redistributors. The `contrib` notes are meant to be documenting news affecting the project contributors, their development, and processes. Finally, `misc` is for things that don't fit anywhere but are still desired to be documented for some reason.
This commit is contained in:
parent
45a89ec61f
commit
03be1ed8b1
|
@ -66,8 +66,41 @@ repos:
|
||||||
- id: changelogs-rst
|
- id: changelogs-rst
|
||||||
name: changelog filenames
|
name: changelog filenames
|
||||||
language: fail
|
language: fail
|
||||||
entry: 'changelog files must be named ####.(breaking|bugfix|deprecation|doc|feature|improvement|trivial|vendor).rst'
|
entry: >-
|
||||||
exclude: changelog/(\d+\.(breaking|bugfix|deprecation|doc|feature|improvement|trivial|vendor).rst|README.rst|_template.rst)
|
changelog files must be named
|
||||||
|
####.(
|
||||||
|
breaking
|
||||||
|
| deprecation
|
||||||
|
| feature
|
||||||
|
| improvement
|
||||||
|
| bugfix
|
||||||
|
| vendor
|
||||||
|
| doc
|
||||||
|
| packaging
|
||||||
|
| contrib
|
||||||
|
| misc
|
||||||
|
)(.#)?(.rst)?
|
||||||
|
exclude: >-
|
||||||
|
(?x)
|
||||||
|
^
|
||||||
|
changelog/(
|
||||||
|
\.gitignore
|
||||||
|
|\d+\.(
|
||||||
|
breaking
|
||||||
|
|deprecation
|
||||||
|
|feature
|
||||||
|
|improvement
|
||||||
|
|bugfix
|
||||||
|
|vendor
|
||||||
|
|doc
|
||||||
|
|packaging
|
||||||
|
|contrib
|
||||||
|
|misc
|
||||||
|
)(\.\d+)?(\.rst)?
|
||||||
|
|README\.rst
|
||||||
|
|_template\.rst
|
||||||
|
)
|
||||||
|
$
|
||||||
files: ^changelog/
|
files: ^changelog/
|
||||||
- id: py-deprecated
|
- id: py-deprecated
|
||||||
name: py library is deprecated
|
name: py library is deprecated
|
||||||
|
|
|
@ -20,10 +20,22 @@ Each file should be named like ``<ISSUE>.<TYPE>.rst``, where
|
||||||
* ``deprecation``: feature deprecation.
|
* ``deprecation``: feature deprecation.
|
||||||
* ``breaking``: a change which may break existing suites, such as feature removal or behavior change.
|
* ``breaking``: a change which may break existing suites, such as feature removal or behavior change.
|
||||||
* ``vendor``: changes in packages vendored in pytest.
|
* ``vendor``: changes in packages vendored in pytest.
|
||||||
* ``trivial``: fixing a small typo or internal change that might be noteworthy.
|
* ``packaging``: notes for downstreams about unobvious side effects
|
||||||
|
and tooling. changes in the test invocation considerations and
|
||||||
|
runtime assumptions.
|
||||||
|
* ``contrib``: stuff that affects the contributor experience. e.g.
|
||||||
|
Running tests, building the docs, setting up the development
|
||||||
|
environment.
|
||||||
|
* ``misc``: changes that are hard to assign to any of the above
|
||||||
|
categories.
|
||||||
|
|
||||||
So for example: ``123.feature.rst``, ``456.bugfix.rst``.
|
So for example: ``123.feature.rst``, ``456.bugfix.rst``.
|
||||||
|
|
||||||
|
.. tip::
|
||||||
|
|
||||||
|
See :file:`pyproject.toml` for all available categories
|
||||||
|
(``tool.towncrier.type``).
|
||||||
|
|
||||||
If your PR fixes an issue, use that number here. If there is no issue,
|
If your PR fixes an issue, use that number here. If there is no issue,
|
||||||
then after you submit the PR and get the PR number you can add a
|
then after you submit the PR and get the PR number you can add a
|
||||||
changelog using that instead.
|
changelog using that instead.
|
||||||
|
|
|
@ -423,9 +423,23 @@ name = "Improved documentation"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[[tool.towncrier.type]]
|
[[tool.towncrier.type]]
|
||||||
# Changes that might not even be worth exposing to the end users.
|
# Notes for downstreams about unobvious side effects and tooling. Changes
|
||||||
directory = "trivial"
|
# in the test invocation considerations and runtime assumptions.
|
||||||
name = "Trivial/internal changes"
|
directory = "packaging"
|
||||||
|
name = "Packaging updates and notes for downstreams"
|
||||||
|
showcontent = true
|
||||||
|
|
||||||
|
[[tool.towncrier.type]]
|
||||||
|
# Stuff that affects the contributor experience. e.g. Running tests,
|
||||||
|
# building the docs, setting up the development environment.
|
||||||
|
directory = "contrib"
|
||||||
|
name = "Contributor-facing changes"
|
||||||
|
showcontent = true
|
||||||
|
|
||||||
|
[[tool.towncrier.type]]
|
||||||
|
# Changes that are hard to assign to any of the above categories.
|
||||||
|
directory = "misc"
|
||||||
|
name = "Miscellaneous internal changes"
|
||||||
showcontent = true
|
showcontent = true
|
||||||
|
|
||||||
[tool.mypy]
|
[tool.mypy]
|
||||||
|
|
Loading…
Reference in New Issue