Towncrier

==============================

No changes since the previous release candidate.

=================================

Features
--------

- Added ``--keep`` option to the ``build`` 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/twisted/towncrier/issues/129>`_)
- Python 3.11 is now officially supported. (`427 <https://github.com/twisted/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/twisted/towncrier/issues/428>`_)


Improved Documentation
----------------------

- Improved contribution documentation. (`415 <https://github.com/twisted/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/twisted/towncrier/issues/424>`_)
- The documentation has been restructured and (hopefully) improved. (`435 <https://github.com/twisted/towncrier/issues/435>`_)
- Added a Markdown-based how-to guide. (`436 <https://github.com/twisted/towncrier/issues/436>`_)
- Defining custom fragments using a TOML array is not deprecated anymore. (`438 <https://github.com/twisted/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/twisted/towncrier/issues/400>`_)


Misc
----

- `406 <https://github.com/twisted/towncrier/issues/406>`_, `#408 <https://github.com/twisted/towncrier/issues/408>`_, `#411 <https://github.com/twisted/towncrier/issues/411>`_, `#412 <https://github.com/twisted/towncrier/issues/412>`_, `#413 <https://github.com/twisted/towncrier/issues/413>`_, `#414 <https://github.com/twisted/towncrier/issues/414>`_, `#416 <https://github.com/twisted/towncrier/issues/416>`_, `#418 <https://github.com/twisted/towncrier/issues/418>`_, `#419 <https://github.com/twisted/towncrier/issues/419>`_, `#421 <https://github.com/twisted/towncrier/issues/421>`_, `#429 <https://github.com/twisted/towncrier/issues/429>`_, `#430 <https://github.com/twisted/towncrier/issues/430>`_, `#431 <https://github.com/twisted/towncrier/issues/431>`_, `#434 <https://github.com/twisted/towncrier/issues/434>`_, `#446 <https://github.com/twisted/towncrier/issues/446>`_, `#447 <https://github.com/twisted/towncrier/issues/447>`_

=============================

No significant changes since the previous release candidate.

=================================

Features
--------

- Make the check subcommand succeed for branches that change the news file

This should enable the ``check`` subcommand to be used as a CI lint step and
not fail when a pull request only modifies the configured news file (i.e. when
the news file is being assembled for the next release). (`337 <https://github.com/twisted/towncrier/issues/337>`_)
- Added support to tables in toml settings, which provides a more intuitive
way to configure custom types. (`369 <https://github.com/twisted/towncrier/issues/369>`_)
- The `towncrier create` command line now has a new `-m TEXT` argument that is used to define the content of the newly created fragment. (`374 <https://github.com/twisted/towncrier/issues/374>`_)


Bugfixes
--------

- The extra newline between the title and rendered content when using ``--draft`` is no longer inserted. (`105 <https://github.com/twisted/towncrier/issues/105>`_)
- The detection of duplicate release notes was fixed and recording changes of same version is no longer triggered.

Support for having the release notes for each version in a separate file is working again. This is a regression introduced in VERSION 19.9.0rc1. (`391 <https://github.com/twisted/towncrier/issues/391>`_)


Improved Documentation
----------------------

- Improve ``CONTRIBUTING.rst`` and add PR template. (`342 <https://github.com/twisted/towncrier/issues/342>`_)
- Move docs too the main branch and document custom fragment types. (`367 <https://github.com/twisted/towncrier/issues/367>`_)
- The CLI help messages were updated to contain more information. (`384 <https://github.com/twisted/towncrier/issues/384>`_)


Deprecations and Removals
-------------------------

- Support for all Python versions older than 3.7 has been dropped. (`378 <https://github.com/twisted/towncrier/issues/378>`_)


Misc
----

- `292 <https://github.com/twisted/towncrier/issues/292>`_, `#330 <https://github.com/twisted/towncrier/issues/330>`_, `#366 <https://github.com/twisted/towncrier/issues/366>`_, `#376 <https://github.com/twisted/towncrier/issues/376>`_, `#377 <https://github.com/twisted/towncrier/issues/377>`_, `#380 <https://github.com/twisted/towncrier/issues/380>`_, `#381 <https://github.com/twisted/towncrier/issues/381>`_, `#382 <https://github.com/twisted/towncrier/issues/382>`_, `#383 <https://github.com/twisted/towncrier/issues/383>`_, `#393 <https://github.com/twisted/towncrier/issues/393>`_, `#399 <https://github.com/twisted/towncrier/issues/399>`_, `#402 <https://github.com/twisted/towncrier/issues/402>`_

=============================

Features
--------

- towncrier --version` was added to the command line interface to show the product version. (`339 <https://github.com/twisted/towncrier/issues/339>`_)
- Support Toml v1 syntax with tomli on Python 3.6+ (`354 <https://github.com/twisted/towncrier/issues/354>`_)


Bugfixes
--------

- Stop writing title twice when ``title_format`` is specified. (`346 <https://github.com/twisted/towncrier/issues/346>`_)
- Disable universal newlines when reading TOML (`359 <https://github.com/twisted/towncrier/issues/359>`_)


Misc
----

- `332 <https://github.com/twisted/towncrier/issues/332>`_, `#333 <https://github.com/twisted/towncrier/issues/333>`_, `#334 <https://github.com/twisted/towncrier/issues/334>`_, `#338 <https://github.com/twisted/towncrier/issues/338>`_

=============================

No significant changes since the previous release candidate.