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.towncrier 的 pyproject.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"
贡献者
Maurits van Rees, m.van.rees@zestsoftware.nl
变更日志
1.3.0 (2022-04-19)
新功能
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)
新功能
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)
新功能
首次发布。[maurits] (问题 #1)
项目详细信息
下载文件
下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于安装包的信息。
源代码分发
zestreleaser.towncrier-1.3.0.tar.gz的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | 7a2fb65a760efc3b6448f8977b6181d801dd9a46625a404154240785f365d357 |
|
MD5 | 33fe84d7259b12aeb01ed14a2108edd0 |
|
BLAKE2b-256 | 2b01012cec7643e8179c08cc1a7cb37d2287fed898a7db3ddcf8ac91b083465e |