使用jinja2模板的自动变更日志生成器。
git-changelog的Python项目详细描述
Git更改日志
自动变更日志生成器。从git日志到更改日志。
- 安装:
sudo pip3 install git-changelog
- 特点:
- Jinja2模板! 您可以完全控制渲染。 内置Keep a Changelog和Angular模板 (另见Conventional Changelog)。
- 提交样式/约定解析。 内置Angular、Atom和基本样式。
- Git服务/提供商不可知, 加上引用解析(问题、提交等)。 内置的GitHub和Gitlab支持。
- 理解Semantic Versioning: 版本和提交的主要/次要/修补程序。 根据上次提交猜测下一个版本。
- 待办事项:
- Plugin architecture, 以支持更多提交样式和git服务。
- Template context injection, 进一步自定义如何呈现变更日志。
- Easy access to "Breaking Changes"在模板中。
- Update changelog in-place,与 commits/dates/versions range limitation ability。
命令行
$ git-changelog --help usage: git-changelog [-h] [-o OUTPUT] [-s {angular,atom,basic}] [-t {angular,keepachangelog}] [-v] REPOSITORYCommand line tool for git-changelog Python package.positional arguments: REPOSITORY The repository path, relative or absolute.optional arguments: -h, --help Show this help message and exit. -o OUTPUT, --output OUTPUT Output to given file. Default: stdout. -s {angular,atom,basic}, --style {angular,atom,basic} The commit style to match against. -t {angular,keepachangelog}, --template {angular,keepachangelog} The Jinja2 template to use. Prefix with "path:" to specify the path to a directory containing a file named "changelog.md". -v, --version Show the current version of the program and exit.