跳转到主要内容

zest.releaser 插件用于调用 towncrier

项目描述

zestreleaser.towncrier

此插件在用 zest.releaser 发布包时调用 towncrier。towncrier 根据新闻片段更新您的历史文件(如 CHANGES.rst)。这例如 被pip使用

插件将调用 towncrier --version <package version> --yes。您可以通过调用 towncrier --version 1.2.3 --draft 来自己预览结果。

towncrier 命令应在您的 PATH 上。插件也可以在它与 fullrelease 脚本(或 prerelease/postrelease)在同一目录时找到它。

安装

使用 pip 安装 zestreleaser.towncrier

$ pip install zestreleaser.towncrier

然后您可以像发布包时通常那样运行 fullrelease。

贡献

支持

如果您遇到问题,请通过提交问题来告知我们。

许可证

该项目采用GPL许可。

pyproject.toml 示例

towncrier 需要在包的根目录中配置 pyproject.toml 文件,紧挨着 setup.py。为了参考,以下是从 zestreleaser.towncrierpyproject.toml 文件。

[tool.towncrier]
issue_format = "`Issue #{issue} <https://github.com/collective/zestreleaser.towncrier/issues/{issue}>`_"
filename = "CHANGES.rst"
directory = "news/"
title_format = "{version} ({project_date})"
# First underline is used for version/date header.
# Second underline is used for the type names (like 'Bug fixes:').
underlines = ["-", ""]

[[tool.towncrier.type]]
directory = "breaking"
name = "Breaking changes:"
showcontent = true

[[tool.towncrier.type]]
directory = "feature"
name = "New features:"
showcontent = true

[[tool.towncrier.type]]
directory = "bugfix"
name = "Bug fixes:"
showcontent = true

[tool.isort]
profile = "black"

贡献者

变更日志

1.3.0 (2022-04-19)

新功能

  • 使用 build 子命令为 towncrier 构建变更日志。修复与 towncrier 21.9.0 或更高版本的兼容性。需要 towncrier 19.9.0 或更高版本。[mcflugen] (问题 #22)

  • 解析时,在Python 3上使用 tomli,在Python 2上使用 toml。与 towncrier 近期之前的行为相同。[maurits] (问题 #23)

1.2.0 (2019-03-05)

新功能

  • 当脚本不易查找时,使用 ‘python -m towncrier’。仍然首先检查 fullrelease 脚本的目录。不再检查 PATH。[maurits] (问题 #17)

错误修复

  • 在发布后不运行完整性检查或运行草案。[maurits] (问题 #16)

1.1.0 (2019-03-05)

新功能

  • 重新发布 1.0.3 为 1.1.0,因为它包含新功能。[maurits] (问题 #9)

1.0.3 (2019-03-05)

新功能

  • 报告新闻片段的完整性:是否有正确的扩展名?是否至少找到一个?显示 towncrier 会做的干燥运行(草案)。[maurits] (问题 #9)

  • 处理每个问题/类型对的新闻条目。[maurits] (问题 #14)

1.0.2 (2019-03-04)

错误修复

  • 修复在 sys.argv 混乱时找到 towncrier 的问题。[maurits] (问题 #6)

1.0.1 (2019-02-20)

错误修复

  • 告诉 bumpversion 不要更新历史记录。[maurits] (问题 #10)

1.0.0 (2019-02-06)

新功能

  • 当需要 towncrier 但未找到时,发出警告并询问。[maurits] (问题 #7)

1.0.0b3 (2018-05-17)

新功能

  • 需要 towncrier 18.5.0,因此我们不需要在配置中包名。[maurits] (问题 #3)

错误修复

  • 首先在 full/prerelease 脚本旁边查找 towncrier。然后回退到在 PATH 上查找。[maurits] (问题 #4)

1.0.0b2 (2018-05-16)

错误修复

  • 当 pyproject.toml 文件不存在时不要失败。[maurits] (问题 #2)

1.0.0b1 (2018-05-15)

新功能

项目详细信息


下载文件

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

源代码分发

zestreleaser.towncrier-1.3.0.tar.gz (17.3 kB 查看哈希值)

上传时间 源代码

由以下支持

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面