Skip to content

SmileyChris/towncrier

This branch is 3 commits ahead of, 129 commits behind twisted/towncrier:trunk.

Folders and files

NameName
Last commit message
Last commit date
May 21, 2024
Apr 11, 2022
Apr 11, 2022
May 24, 2024
May 22, 2024
Sep 23, 2022
Apr 12, 2022
Nov 7, 2023
May 21, 2024
May 24, 2024
Sep 15, 2023
Aug 9, 2017
Jun 13, 2023
Sep 28, 2022
Nov 8, 2023
Jun 12, 2023
May 21, 2024
Feb 5, 2024
Apr 28, 2024
May 22, 2024

Repository files navigation

Hear ye, hear ye, says the towncrier

Documentation License: MIT PyPI release

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 a ticket.

To get started, check out our tutorial!

Project Links

About

Manage the release notes for your project.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Python 99.4%
  • Other 0.6%