Towncrier 23.6.0

towncrier 23.6.0 (2023-06-06)

This is the last release to support Python 3.7.

Features

• Make towncrier create use the fragment counter rather than failing on existing fragment names.

  For example, if there is an existing fragment named 123.feature, then towncrier create 123.feature will now create a fragment named 123.feature.1. (#475)

• Provide a default Markdown template if the configured filename ends with .md.

  The Markdown template uses the same rendered format as the default reStructuredText template, but with a Markdown syntax. (#483)

• Towncrier no longer depends on setuptools & uses importlib.resources (or its backport) instead. (#496)

• Added pre-commit hooks for checking and updating news in projects using pre-commit. (#498)

• Calling towncrier check without an existing configuration, will just show only an error message.

  In previous versions, a traceback was generated instead of the error message. (#501)

Bugfixes

• Fix creating fragment in a section not adding random characters.

  For example, towncrier create some_section/+.feature should end up as a fragment named something like news/some_section/+a4e22da1.feature. (#468)

• Fix the ReadTheDocs build for towncrier which was broken due to the python version in use being 3.8. Upgrade to 3.11. (#509)

Improved Documentation

• Moved man page to correct section (#470)
• Update link to Quick Start in configuration.html to point to Tutorial instead. (#504)
• Add a note about the build command's --version requiring the command to be explicitly passed. (#511)
• Fix typos in the Pre-Commit docs. (#512)

Misc

• #459, #462, #472, #485, #486, #487, #488, #495, #497, #507, #1117, #513

Towncrier 23.6.0rc1

towncrier 23.6.0rc1 (2023-06-05)

This is the last release to support Python 3.7.

Features

• Make towncrier create use the fragment counter rather than failing on existing fragment names.

  For example, if there is an existing fragment named 123.feature, then towncrier create 123.feature will now create a fragment named 123.feature.1. (#475)

• Provide a default Markdown template if the configured filename ends with .md.

  The Markdown template uses the same rendered format as the default reStructuredText template, but with a Markdown syntax. (#483)

• Towncrier no longer depends on setuptools & uses importlib.resources (or its backport) instead. (#496)

• Added pre-commit hooks for checking and updating news in projects using pre-commit. (#498)

• Calling towncrier check without an existing configuration, will just show only an error message.

  In previous versions, a traceback was generated instead of the error message. (#501)

Bugfixes

• Fix creating fragment in a section not adding random characters.

  For example, towncrier create some_section/+.feature should end up as a fragment named something like news/some_section/+a4e22da1.feature. (#468)

• Fix the ReadTheDocs build for towncrier which was broken due to the python version in use being 3.8. Upgrade to 3.11. (#509)

Improved Documentation

• Moved man page to correct section (#470)
• Update link to Quick Start in configuration.html to point to Tutorial instead. (#504)
• Add a note about the build command's --version requiring the command to be explicitly passed. (#511)
• Fix typos in the Pre-Commit docs. (#512)

Misc

• #459, #462, #472, #485, #486, #487, #488, #495, #497, #507, #1117, #513

Towncrier 22.12.0

towncrier 22.12.0 (2022-12-21)

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/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>_)

22.12.0rc1

towncrier 22.12.0rc1 (2022-12-20)

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/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>_)

Towncrier 22.8.0

towncrier 22.8.0 (2022-08-29)

No significant changes since the previous release candidate.

towncrier 22.8.0.rc1 (2022-08-28)

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/hawkowl/towncrier/issues/337>_)

• Added support to tables in toml settings, which provides a more intuitive
  way to configure custom types. (#369 <https://github.com/hawkowl/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/hawkowl/towncrier/issues/374>_)

Bugfixes

• The extra newline between the title and rendered content when using --draft is no longer inserted. (#105 <https://github.com/hawkowl/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/hawkowl/towncrier/issues/391>_)

Improved Documentation

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

Deprecations and Removals

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

Towncrier 22.8.0rc1

towncrier 22.8.0.rc1 (2022-08-28)

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/hawkowl/towncrier/issues/337>_)

• Added support to tables in toml settings, which provides a more intuitive
  way to configure custom types. (#369 <https://github.com/hawkowl/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/hawkowl/towncrier/issues/374>_)

Bugfixes

• The extra newline between the title and rendered content when using --draft is no longer inserted. (#105 <https://github.com/hawkowl/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/hawkowl/towncrier/issues/391>_)

Improved Documentation

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

Deprecations and Removals

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