https://github.com/twisted/towncrier

Manage the release notes for your project.
https://github.com/twisted/towncrier

newsfile project-management python release-automation release-notes

Last synced: 10 days ago
JSON representation

Manage the release notes for your project.

• Host: GitHub
• URL: https://github.com/twisted/towncrier
• Owner: twisted
• License: mit
• Created: 2015-12-27T14:23:37.000Z (almost 9 years ago)
• Default Branch: trunk
• Last Pushed: 2024-04-15T16:53:04.000Z (7 months ago)
• Last Synced: 2024-04-16T03:18:45.194Z (7 months ago)
• Topics: newsfile, project-management, python, release-automation, release-notes
• Language: Python
• Homepage: https://towncrier.readthedocs.io
• Size: 772 KB
• Stars: 731
• Watchers: 17
• Forks: 106
• Open Issues: 79
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-pyproject - towncrier - A utility to produce useful, summarised news files for your project. (Other Tools)

README

        
Hear ye, hear ye, says the ``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 `_, `pytest `_, `pip `_, `BuildBot `_, and `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**.

Philosophy

----------

``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 `_!

.. links

Project Links

-------------

- **PyPI**: https://pypi.org/project/towncrier/

- **Documentation**: https://towncrier.readthedocs.io/

- **Release Notes**: https://github.com/twisted/towncrier/blob/trunk/NEWS.rst

- **License**: `MIT `_