跳转到主要内容

根据标签消息和短日志生成变更日志

项目描述

根据提交标签和短日志自动发布和变更日志。

Documentation Status PyPI Release Changelog MIT Licensed

归属权为Python项目提供自动化基本发布工作流程的简单工具。其核心功能是生成基于存储库中版本标签的Markdown格式变更日志,既可以与现有工作流程结合,也可以通过单个命令自动化整个发布准备过程。

在生成变更日志时,归属权将找到所有以“v”开头后跟有效的PEP 440版本标识符的标签名称。然后,它将使用每个标签的消息,结合“短日志”,生成一个包含对项目所有贡献者认可的有序变更日志。输出可以保存到您首选的变更日志文件,也可以作为发布工作流程的一部分传递到其他工具

$ attribution generate
project name
============

v0.2
----

Another release

```
$ git shortlog -s v0.1...v0.2
    1 Ash
    3 Misty
```

v0.1
----

First release

```
$ git shortlog -s ...v0.1
    1 Ash
```

如果您更喜欢端到端解决方案,归属权也可以用于创建发布说明,更新与匹配版本相对应的__version__.py文件,并对包含最终变更日志的签名版本升级提交进行标记

$ attribution tag -m "Final release" 1.0
$ head CHANGELOG.md
project name
============

v1.0
----

Final release

```
$ git shortlog -s v0.2...v1.0
    3 Ash
    2 Brock
```

归属权是一个完全自托管的工程。变更日志由归属权生成,从版本1.2.0开始,所有发布都使用归属权创建。

安装

归属权需要Python 3.7或更高版本。您可以从PyPI安装它

$ pip install attribution

attribution 应该为大多数常见的 Python 项目猜测合理的默认值,但为了获得最佳效果,您应该初始化项目配置

$ attribution init
Project name [attribution]:
Package namespace [attribution]:
Use __version__.py file [Y/n]:

这将自动将适当的配置添加到您的项目 pyproject.toml

[tool.attribution]
name = "attribution"
package = "attribution"
version_file = true

更多详细信息请参阅 用户指南

许可证

attribution 版权归 Amethyst Reese 所有,并采用 MIT 许可协议。我在此仓库中向您提供代码是在开源许可下。这是一个个人仓库;您从我获得的代码许可来自我,而不是来自我的雇主。有关详细信息,请参阅 LICENSE 文件。

项目详情


下载文件

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

源代码分发

attribution-1.8.0.tar.gz (24.6 kB 查看哈希值)

上传时间 源代码

构建分发

attribution-1.8.0-py3-none-any.whl (19.8 kB 查看哈希值)

上传时间 Python 3

由以下机构支持