towncrier.. image:: https://img.shields.io/badge/Docs-Read%20The%20Docs-black :alt: Documentation :target: https://towncrier.readthedocs.io/
.. image:: https://img.shields.io/badge/license-MIT-C06524 :alt: License: MIT :target: https://github.com/twisted/towncrier/blob/trunk/LICENSE
.. image:: https://img.shields.io/pypi/v/towncrier :alt: PyPI release :target: https://pypi.org/project/towncrier/
towncrier is a utility to produce useful, summarized news files (also known as changelogs) for your project.
Rather than reading the Git history, or having one single file which developers all write to and produce merge conflicts, towncrier reads "news fragments" which contain information useful to end users.
Used by Twisted <https://github.com/twisted/twisted>, pytest <https://github.com/pytest-dev/pytest/>, pip <https://github.com/pypa/pip/>, BuildBot <https://github.com/buildbot/buildbot>, and attrs <https://github.com/python-attrs/attrs>_, among others.
While the command line tool towncrier requires Python to run, as long as you don't use any Python-specific affordances (like auto-detection of the project version), it is usable with any project type on any platform.
towncrier delivers the news which is convenient to those that hear it, not those that write it.
That is, by duplicating what has changed from the "developer log" (which may contain complex information about the original issue, how it was fixed, who authored the fix, and who reviewed the fix) into a "news fragment" (a small file containing just enough information to be useful to end users), towncrier can produce a digest of the changes which is valuable to those who may wish to use the software.
These fragments are also commonly called "topfiles" or "newsfiles".
towncrier works best in a development system where all merges involve closing an issue.
To get started, check out our tutorial <https://towncrier.readthedocs.io/en/latest/tutorial.html>_!
.. links
MIT <https://github.com/twisted/towncrier/blob/trunk/LICENSE>_FAQs
Building newsfiles for your project.
We found that towncrier demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."