从git历史记录获取版本信息的工具
vergit的Python项目详细描述
从git标记和格式中提取版本信息的简单工具 它带有可选的发布后提交信息。
版本标记可以选择使用v前缀,并且可以包括预发布 版本。
安装
从pypi安装:
pip install vergit
用法
完全使用:
vergit [-h] [--format {long,short,default,json}] [path]
可以省略path,默认为当前目录。
有几种不同的格式可供使用:
- long始终包含git修订信息。
- short从不包含git修订信息,只包含发布版本。
- default如果在预发行版上或有提交,则使用长格式 发行后,否则格式较短。
- json输出描述版本的json数据。
示例
如果当前提交被标记为v1.0.0:
$ vergit 1.0.0 $ vergit --format short 1.0.0 $ vergit --format long 1.0.0+git-0-123abcd $ vergit --format json {"version": "1.0.0", "git": "+git-0-123abcd", "gitn": "0", "gitsha": "123abcd", "pre_release": false}
如果当前之前的提交被标记为1.0.0:
$ vergit 1.0.0+git-1-123abcd $ vergit --format short 1.0.0 $ vergit --format long 1.0.0+git-0-123abcd $ vergit --format json {"version": "1.0.0", "git": "+git-1-123abcd", "gitn": "1", "gitsha": "123abcd", "pre_release": false}
如果当前提交被标记为v1.0.0rc1:
$ vergit 1.0.0rc1+git-0-123abcd $ vergit --format short 1.0.0rc1 $ vergit --format long 1.0.0rc1+git-0-123abcd $ vergit --format json {"version": "1.0.0rc1", "git": "+git-0-123abcd", "gitn": "0", "gitsha": "123abcd", "pre_release": true}