towncrier 22.12.0 (2022-12-21)
Features
-
Added
--keep
option to thebuild
command that allows generating a newsfile, but keeps the newsfragments in place.
This option can not be used together with--yes
. (#129 <https://github.com/hawkowl/towncrier/issues/129>
_) -
Python 3.11 is now officially supported. (
#427 <https://github.com/hawkowl/towncrier/issues/427>
_) -
You can now create fragments that are not associated with issues. Start the name of the fragment with
+
(e.g.+anything.feature
).
The content of these orphan news fragments will be included in the release notes, at the end of the category corresponding to the file extension.To help quickly create a unique orphan news fragment,
towncrier create +.feature
will append a random string to the base name of the file, to avoid name collisions. (#428 <https://github.com/hawkowl/towncrier/issues/428>
_)
Improved Documentation
- Improved contribution documentation. (
#415 <https://github.com/hawkowl/towncrier/issues/415>
_) - Correct a typo in the readme that incorrectly documented custom fragments in a format that does not work. (
#424 <https://github.com/hawkowl/towncrier/issues/424>
_) - The documentation has been restructured and (hopefully) improved. (
#435 <https://github.com/hawkowl/towncrier/issues/435>
_) - Added a Markdown-based how-to guide. (
#436 <https://github.com/hawkowl/towncrier/issues/436>
_) - Defining custom fragments using a TOML array is not deprecated anymore. (
#438 <https://github.com/hawkowl/towncrier/issues/438>
_)
Deprecations and Removals
- Default branch for
towncrier check
is now "origin/main" instead of "origin/master".
If "origin/main" does not exist, fallback to "origin/master" with a deprecation warning. (#400 <https://github.com/hawkowl/towncrier/issues/400>
_)