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.
Philosophytowncrier 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!
Project LinksDocumentation: https://towncrier.readthedocs.io/
Release Notes: https://github.com/twisted/towncrier/blob/trunk/NEWS.rst
License: MIT
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution Built Distribution File detailsDetails for the file towncrier-24.8.0.tar.gz.
013423ee7eed102b2f393c287d22d95f66f1a3ea10a4baa82d298001a7f18af3 MD5 c0fbdf0458671ceadfd17dc16185d4a0 BLAKE2b-256 69d7a5183f788cf4fabf03f7c767ae0b968249b0c737eb64b4d87a07ae01fea7
See more details on using hashes here.
File detailsDetails for the file towncrier-24.8.0-py3-none-any.whl.
9343209592b839209cdf28c339ba45792fbfe9775b5f9c177462fd693e127d8d MD5 7e710a14eba317e412fca50943e396fa BLAKE2b-256 931b2f7b88506e22d9798c139261af4946865c0787cfa345514ca3c70173a9cc
See more details on using hashes here.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4