zestreleaser.towncrier 1.0.0b1

Installation

Install zestreleaser.towncrier with pip:

$ pip install zestreleaser.towncrier

Then you can run fullrelease like you would normally do when releasing a package.

Contribute

• Issue Tracker: https://github.com/collective/zestreleaser.towncrier/issues

• Source Code: https://github.com/collective/zestreleaser.towncrier

Support

If you are having problems, please let us know by filing an issue.

License

The project is licensed under the GPL.

pyproject.toml example

towncrier needs a configured pyproject.toml file in the root of the package, next to the setup.py. For reference, here is the literal pyproject.toml file from zestreleaser.towncrier:

[tool.towncrier]
# The package name must be importable for now, even when not used.
# See these pull requests:
# https://github.com/hawkowl/towncrier/pull/107
# https://github.com/hawkowl/towncrier/pull/112
# Workaround can be: package = "towncrier"
package = "zestreleaser.towncrier"
issue_format = "`Issue #{issue} <https://github.com/collective/zestreleaser.towncrier/issues/{issue}>`_"
filename = "CHANGES.rst"
directory = "news/"
title_format = "{version} ({project_date})"
# First underline is used for version/date header.
# Second underline is used for the type names (like 'Bug fixes:').
underlines = ["-", ""]

[[tool.towncrier.type]]
directory = "breaking"
name = "Breaking changes:"
showcontent = true

[[tool.towncrier.type]]
directory = "feature"
name = "New features:"
showcontent = true

[[tool.towncrier.type]]
directory = "bugfix"
name = "Bug fixes:"
showcontent = true