📝💄 Split the "process" change log entry to 3 #12853
Conversation
This is a preparatory step for further adding of new changelog fragment types.
Said commit is a formatting change.
webknjaz
force-pushed
the
maintenance/towncrier-packaging-n-contrib-types
branch
from
bbc6990 to
cf01718
Compare
webknjaz
force-pushed
the
maintenance/towncrier-packaging-n-contrib-types
branch
from
cf01718 to
9e6f247
Compare
@sbidoul yes! I adjusted a few things to make the linters pass and added that fragment. I was in a bit of a hurry to get off the train on the way home from EuroPython, and so I missed this. It should be good now. N.B. I also noticed that despite the contrib guide saying that |
webknjaz
force-pushed
the
maintenance/towncrier-packaging-n-contrib-types
branch
from
9e6f247 to
864eff4
Compare
| @@ -110,8 +110,8 @@ public is concerned, typo fixes, white space modification, etc. To mark a PR | |||
| as trivial a contributor simply needs to add a randomly named, empty file to | |||
| the ``news/`` directory with the extension of ``.trivial.rst``. If you are on a | |||
| POSIX like operating system, one can be added by running | |||
| ``touch news/$(uuidgen).trivial.rst``. On Windows, the same result can be | |||
| achieved in Powershell using ``New-Item "news/$([guid]::NewGuid()).trivial.rst"``. | |||
| ``touch news/+$(uuidgen).trivial.rst``. On Windows, the same result can be | |||
There was a problem hiding this comment.
@sbidoul FYI, fragments with the leading + are called “orphan” within Towncrier and so it's usually good to follow their conventions for this random stuff that might not need to link issue/PR numbers.
Previously, the change log had a section called "Process". And some of
the incoming pull requests would add change notes there when they
couldn't be put into other categories. Using it like that is not a
good idea. This patch rethinks the categorization and the audiences of
a few common change types and defines respective categories that
replace "Process".
The new categories are:
* `packaging` -- news for downstream re-packagers
* `contrib` -- news for regular project participants
* `misc` -- public change log for things that don't fit anywhere but
are useful
Resolves pypa#12555
webknjaz
force-pushed
the
maintenance/towncrier-packaging-n-contrib-types
branch
from
864eff4 to
6e5fb51
Compare
|
@pradyunsg ping |
| )(\.\d+)?(\.rst)? | ||
| |[0-9a-zA-Z-_]+\.vendor(\.\d+)?(\.rst)? # special-case vendoring |
There was a problem hiding this comment.
| )(\.\d+)?(\.rst)? | |
| |[0-9a-zA-Z-_]+\.vendor(\.\d+)?(\.rst)? # special-case vendoring | |
| )(\.\d+)?\.rst | |
| |[0-9a-zA-Z-_]+\.vendor(\.\d+)?\.rst # special-case vendoring |
Previously, the change log had a section called "Process". And some of
the incoming pull requests would add change notes there when they
couldn't be put into other categories. Using it like that is not a
good idea. This patch rethinks the categorization and the audiences of
a few common change types and defines respective categories that
replace "Process".
The new categories are:
packaging-- news for downstream re-packagerscontrib-- news for regular project participantsmisc-- public change log for things that don't fit anywhere butare useful
Resolves #12555
Change note demo: https://pip--12853.org.readthedocs.build/en/12853/news/#contributor-facing-changes