从git标记生成变更日志。

changelogfromtags的Python项目详细描述


changelogfromtagsGit Logopipeline statusPEP8Downloads

Changelog的生成从未如此简单

Fully automated changelog generation-此包基于git标记生成一个变更日志文件。在

因为现在不必手动填充CHANGELOG.md:只需运行脚本,放松并在下一个版本之前喝一杯:咖啡!:塔达:

变更日志有什么意义?

为了让用户和贡献者更容易准确地看到项目的每个版本(或版本)之间发生了哪些显著的变化。在

我为什么要在意?

因为软件工具是为people设计的。”变更日志使用户和 投稿人可以准确地看到他们之间的显著变化 项目的发布(或版本)。”

https://keepachangelog.com

安装

安装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。在

输出示例

项目特点及优势

  • Changelog条目直接取自git标记消息
  • 除了python和git没有其他要求
  • 生成规范的、整洁的变更日志文件,默认部分在basic changelog guidelines之后

替代品

这是我找到的一个wikipage list of alternatives。但没有一个能满足我的要求。在

如果您知道其他项目,请随时编辑此Wiki页面!

许可证

changelogfromtags在MIT License下释放。在

欢迎加入QQ群-->: 979659372 Python中文网_新手群

推荐PyPI第三方库


热门话题
javaelk:如何在Kibana中按异常类对stacktrace进行分组   java两个组件使用MigLayout相互重叠   java Hibernate标准获取关联实体的列表,而不是父实体的列表   从Java关闭另一个应用程序,但不是由当前Java应用程序启动   java使用OGNL获取参数   java如何在SSLEngine中启用密码TLS\U DHE\U RSA\U和\U AES\U 256\U GCM\U SHA384   在Java中有效地比较两个列表<Object[]>   java杀死挂起的线程   在java中从指定模式前后的字符串中提取子字符串   存储整数的java HashMap替代方案   java如何使用LibGDX加载特定于语言的资产?   java如何使用JSON响应从维基百科读取结构化数据   java无法连接到Spark Master:原因是:[已解除关联]   java如何配置Elastic beanstalk classic负载平衡器以使用CLI终止HTTPS   java筛网中的奥斯汀大于int   java PircBot在每个用户上迭代一组命令   java将带有Jackson的hashmap编组为XML的错误结构   testng中的java设置testfailure给出了正回报   java如何在IntelliJ中正确配置Eclipse项目?