Towncrier 开源项目使用教程

Towncrier 开源项目使用教程

towncrierA status dashboard项目地址:https://gitcode.com/gh_mirrors/tow/towncrier

1. 项目的目录结构及介绍

Towncrier 是一个用于构建项目新闻文件的工具，它允许开发者将小片段的更新说明（news fragments）合并成最终的变更日志或新闻通知。虽然具体的项目结构因个人或团队实践而异，但使用 Towncrier 的项目通常会遵循以下推荐的目录结构：

• src/ 或 project_name/: 这是项目的主要源代码所在目录。
• changes/ 或根据你的配置定义的目录：存放各个“新闻片段”，每个片段代表项目的一个具体变化或更新。
• pyproject.toml 和/或 towncrier.toml: 配置文件，定义了如何收集和格式化这些片段。
• 可能还包含 setup.py 或 setup.cfg 文件，用于项目的打包和安装。

2. 项目的启动文件介绍

在 Towncrier 的上下文中，并不存在传统的“启动文件”。不过，核心操作是通过命令行接口执行的。主要交互方式是运行 towncrier 命令。一般流程中，开发者不会直接编辑一个所谓的“启动文件”来启动 Towncrier。而是根据需要，在项目的根目录下执行如下的命令来生成或查看新闻文件：

python3 -m towncrier

或者配置好之后简单地：

towncrier

此命令将会依据配置文件指定的规则处理位于特定目录中的新闻片段，并生成变更日志文件。

3. 项目的配置文件介绍

pyproject.toml 或 towncrier.toml

Towncrier 使用 pyproject.toml 文件中的 [tool.towncrier] 部分或者专门的 towncrier.toml 来进行配置。以下是基本配置示例：

[tool.towncrier]
directory = "changes"
package = "your_package_name"
ʹformat = "{package} {version}\n{date:%Y-%m-%d}\n\n{sections}"

[[tool.towncrier.section]]
name = "特性"
marker = ":feature:"

• directory: 指定新闻片段存储的目录。
• package: 通常是你的Python包名，用于自动生成的信息中。
• format: 定义生成的新闻文件的格式模板。
• section 列表: 定义不同的章节及其对应的前缀标记，如上面的“特性”章节。

通过这种方式，你可以定制生成的新闻文件的样式和结构，确保它符合你的项目需求和发布标准。记得，配置可以根据实际项目需求调整，以支持Markdown或reStructuredText等不同格式的新闻片段。

towncrierA status dashboard项目地址:https://gitcode.com/gh_mirrors/tow/towncrier