从git标记生成变更日志。
changelogfromtags的Python项目详细描述
changelogfromtags
Changelog的生成从未如此简单
Fully automated changelog generation-此包基于git标记生成一个变更日志文件。在
因为现在不必手动填充CHANGELOG.md
:只需运行脚本,放松并在下一个版本之前喝一杯:咖啡!:塔达:
变更日志有什么意义?为了让用户和贡献者更容易准确地看到项目的每个版本(或版本)之间发生了哪些显著的变化。在
我为什么要在意?因为软件工具是为people设计的。”变更日志使用户和
投稿人可以准确地看到他们之间的显著变化
项目的发布(或版本)。”
安装
安装python包,如下所示:
$ pip install changelogfromtags
:警告:changelogfromtags
已成功测试git version>;=2.20.0
它不适用于git 2.11.0及以下版本。。。在
使用
假设您有关于git标记的消息:
^{pr2}$
使用CLI运行:
usage: changelogfromtags [-h] [-p [PREFIX]] [-t [TITLE]] [--tag TAG]
[--verbose]
Generate a change log from git tags.
optional arguments:
-h, --help show this help message and exit
-p [PREFIX], --prefix [PREFIX]
Append a charachter before each line of the message
tag if it is not present.
-t [TITLE], --title [TITLE]
Title in the header
--tag TAG Display entry for the given tag
--verbose, -v
示例
$ changelogfromtags
Changelog
=========
0.1.1 (06/01/2020)
------------------
Deploy package changelogfromtags on pypi
0.1.0 (06/01/2020)
------------------
First release
You retrieve the content of `git tag 0.1.0 -n200`
在不存在的条目上添加前缀:
$ changelogfromtags --prefix "- "
Changelog
=========
0.1.1 (06/01/2020)
------------------
- Deploy package changelogfromtags on pypi
0.1.0 (06/01/2020)
------------------
- First release
- You retrieve the content of `git tag 0.1.0 -n200`
到特定标记的条目:
$ changelogfromtags --tag 0.1.1
0.1.1 (06/01/2020)
------------------
- Deploy package changelogfromtags on pypi
与Docker一起运行
docker run -it --rm -v $(pwd):/app r4mb0/changelogfromtags
See changelogfromtags docker image。在
输出示例
- 看看这个项目的^{str1}$CHANGELOG.md
项目特点及优势
- Changelog条目直接取自git标记消息
- 除了python和git没有其他要求
- 生成规范的、整洁的变更日志文件,默认部分在basic changelog guidelines之后
替代品
这是我找到的一个wikipage list of alternatives。但没有一个能满足我的要求。在
如果您知道其他项目,请随时编辑此Wiki页面!
许可证
changelogfromtags在MIT License下释放。在
标签:
- 项目
推荐PyPI第三方库
为了让用户和贡献者更容易准确地看到项目的每个版本(或版本)之间发生了哪些显著的变化。在
我为什么要在意?因为软件工具是为people设计的。”变更日志使用户和
投稿人可以准确地看到他们之间的显著变化
项目的发布(或版本)。”
安装
安装python包,如下所示:
$ pip install changelogfromtags
:警告:changelogfromtags
已成功测试git version>;=2.20.0
它不适用于git 2.11.0及以下版本。。。在
使用
假设您有关于git标记的消息:
^{pr2}$
使用CLI运行:
usage: changelogfromtags [-h] [-p [PREFIX]] [-t [TITLE]] [--tag TAG]
[--verbose]
Generate a change log from git tags.
optional arguments:
-h, --help show this help message and exit
-p [PREFIX], --prefix [PREFIX]
Append a charachter before each line of the message
tag if it is not present.
-t [TITLE], --title [TITLE]
Title in the header
--tag TAG Display entry for the given tag
--verbose, -v
示例
$ changelogfromtags
Changelog
=========
0.1.1 (06/01/2020)
------------------
Deploy package changelogfromtags on pypi
0.1.0 (06/01/2020)
------------------
First release
You retrieve the content of `git tag 0.1.0 -n200`
在不存在的条目上添加前缀:
$ changelogfromtags --prefix "- "
Changelog
=========
0.1.1 (06/01/2020)
------------------
- Deploy package changelogfromtags on pypi
0.1.0 (06/01/2020)
------------------
- First release
- You retrieve the content of `git tag 0.1.0 -n200`
到特定标记的条目:
$ changelogfromtags --tag 0.1.1
0.1.1 (06/01/2020)
------------------
- Deploy package changelogfromtags on pypi
与Docker一起运行
docker run -it --rm -v $(pwd):/app r4mb0/changelogfromtags
See changelogfromtags docker image。在
输出示例
- 看看这个项目的^{str1}$CHANGELOG.md
项目特点及优势
- Changelog条目直接取自git标记消息
- 除了python和git没有其他要求
- 生成规范的、整洁的变更日志文件,默认部分在basic changelog guidelines之后
替代品
这是我找到的一个wikipage list of alternatives。但没有一个能满足我的要求。在
如果您知道其他项目,请随时编辑此Wiki页面!
许可证
changelogfromtags在MIT License下释放。在
标签:
- 项目
推荐PyPI第三方库
因为软件工具是为people设计的。”变更日志使用户和 投稿人可以准确地看到他们之间的显著变化 项目的发布(或版本)。”
安装
安装python包,如下所示:
$ pip install changelogfromtags
:警告:changelogfromtags
已成功测试git version>;=2.20.0
它不适用于git 2.11.0及以下版本。。。在
使用
假设您有关于git标记的消息:
^{pr2}$使用CLI运行:
usage: changelogfromtags [-h] [-p [PREFIX]] [-t [TITLE]] [--tag TAG]
[--verbose]
Generate a change log from git tags.
optional arguments:
-h, --help show this help message and exit
-p [PREFIX], --prefix [PREFIX]
Append a charachter before each line of the message
tag if it is not present.
-t [TITLE], --title [TITLE]
Title in the header
--tag TAG Display entry for the given tag
--verbose, -v
示例
$ changelogfromtags
Changelog
=========
0.1.1 (06/01/2020)
------------------
Deploy package changelogfromtags on pypi
0.1.0 (06/01/2020)
------------------
First release
You retrieve the content of `git tag 0.1.0 -n200`
在不存在的条目上添加前缀:
$ changelogfromtags --prefix "- "
Changelog
=========
0.1.1 (06/01/2020)
------------------
- Deploy package changelogfromtags on pypi
0.1.0 (06/01/2020)
------------------
- First release
- You retrieve the content of `git tag 0.1.0 -n200`
到特定标记的条目:
$ changelogfromtags --tag 0.1.1
0.1.1 (06/01/2020)
------------------
- Deploy package changelogfromtags on pypi
与Docker一起运行
docker run -it --rm -v $(pwd):/app r4mb0/changelogfromtags
See changelogfromtags docker image。在
输出示例
- 看看这个项目的^{str1}$CHANGELOG.md
项目特点及优势
- Changelog条目直接取自git标记消息
- 除了python和git没有其他要求
- 生成规范的、整洁的变更日志文件,默认部分在basic changelog guidelines之后
替代品
这是我找到的一个wikipage list of alternatives。但没有一个能满足我的要求。在
如果您知道其他项目,请随时编辑此Wiki页面!
许可证
changelogfromtags在MIT License下释放。在
- 项目
标签: