跳转到主要内容

为您的项目构建新闻文件。

项目描述

Documentation License: MIT PyPI release

towncrier 是一个用于为您的项目生成有用的、总结性的新闻文件(也称为变更日志)的工具。

与直接阅读 Git 历史记录或有一个所有开发者都写入并产生合并冲突的单个文件相比,towncrier 读取包含对 最终用户 有用信息的“新闻片段”。

TwistedpytestpipBuildBotattrs 等项目使用。

虽然命令行工具 towncrier 需要 Python 来运行,但只要您不使用任何 Python 特定的功能(如自动检测项目版本),它就可以在 任何平台 上的 任何项目类型 中使用。

理念

towncrier 将方便听到的新闻传递给听众,而不是那些编写它的人。

也就是说,通过将“开发者日志”中发生的变化(可能包含有关原始问题的复杂信息、如何修复、谁编写了修复以及谁审核了修复)复制到“新闻片段”(一个仅包含足够信息以便对最终用户有用的文件)中,towncrier 可以生成对希望使用该软件的人有价值的更改摘要。这些片段也通常被称为“topfiles”或“newsfiles”。

towncrier 在所有合并都涉及关闭问题的开发系统中工作得最好。

要开始,查看我们的 教程

项目详情


下载文件

下载适合您平台文件。如果您不确定选择哪一个,请了解更多关于安装包的信息。

源代码分发

towncrier-24.8.0.tar.gz (61.6 kB 查看哈希值)

上传时间 源代码

构建分发

towncrier-24.8.0-py3-none-any.whl (57.0 kB 查看哈希值)

上传时间 Python 3

由以下支持