使用Jinja2模板的自动变更日志生成器。
项目描述
# gitolog
自动变更日志生成器。从git日志到变更日志。
- 安装:`sudo pip3 install gitolog`
- 特性
- [Jinja2][jinja2] 模板!
你可以完全控制渲染。
内置 [Keep a Changelog][keep-a-changelog] 和 [Angular][angular] 模板
(也见 [Conventional Changelog][conventional-changelog])。
- 提交样式/约定的解析。
内置 [Angular][angular-style], [Atom][atom-style] 和基本样式。
- Git服务/提供者无关,
加上引用解析(问题、提交等)。
内置 [GitHub][github-refs] 和 [Gitlab][gitlab-refs] 支持。
- 理解 [语义化版本控制][semantic-versioning]
版本和提交的major/minor/patch。
基于最后提交猜测下一个版本。
- 待办事项
- [插件架构][issue-7],
以支持更多提交样式和Git服务。
- [模板上下文注入][issue-4],
进一步自定义你的变更日志的渲染方式。
- [在模板中轻松访问“重大变更”][issue-1]。
- [就地更新变更日志][issue-2],与
[提交/日期/版本范围限制能力][issue-3] 配对。
## 命令行
```console
$ gitolog --help
用法:gitolog [-h] [-o 输出] [-s {angular,atom,basic}]
[-t {angular,keepachangelog}] [-v]
REPOSITORY
gitolog Python 包的命令行工具。
位置参数
REPOSITORY 仓库路径,相对或绝对。
可选参数
-h, --help 显示此帮助信息并退出。
-o 输出, --output 输出
输出到指定的文件。默认:标准输出。
-s {angular,atom,basic}, --style {angular,atom,basic}
要匹配的提交风格。
-t {angular,keepachangelog}, --template {angular,keepachangelog}
要使用的 Jinja2 模板。使用 "path:" 前缀来
指定包含名为 "changelog.md" 文件的目录的路径。
-v, --version 显示程序的当前版本并退出。
```
[jinja2]: http://jinja.pocoo.org/
[keep-a-changelog]: http://keepachangelog.com/en/1.0.0/
[angular]: https://github.com/angular/angular/blob/master/CHANGELOG.md
[conventional-changelog]: https://github.com/conventional-changelog/conventional-changelog
[semantic-versioning]: http://semver.org/spec/v2.0.0.html
[atom-style]: https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages
[angular-style]: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
[github-refs]: https://help.github.com/articles/autolinked-references-and-urls/
[gitlab-refs]: https://docs.gitlab.com/ce/user/markdown.html#special-gitlab-references
[issue-1]: https://gitlab.com/pawamoy/gitolog/issues/1
[issue-2]: https://gitlab.com/pawamoy/gitolog/issues/2
[issue-3]: https://gitlab.com/pawamoy/gitolog/issues/3
[issue-4]: https://gitlab.com/pawamoy/gitolog/issues/4
[issue-5]: https://gitlab.com/pawamoy/gitolog/issues/5
[issue-6]: https://gitlab.com/pawamoy/gitolog/issues/6
[issue-7]: https://gitlab.com/pawamoy/gitolog/issues/7
# Changelog
此项目的所有显著更改都将记录在此文件中。
格式基于 [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
并遵循 [语义化版本控制](http://semver.org/spec/v2.0.0.html)。
## [0.1.1](https://gitlab.com/pawamoy/gitolog/tags/0.1.1) ([compare](https://gitlab.com/pawamoy/gitolog/compare/0.1.0...0.1.1)) - 2018-06-27
### 修复
- 修复与 MANIFEST.in 一起构建的问题,添加许可证文件 ([013fb69](https://gitlab.com/pawamoy/gitolog/commit/013fb691826924d6f71b4159a8fa650e40324db3)).
### 其他
- 改善可读性 ([5e590f6](https://gitlab.com/pawamoy/gitolog/commit/5e590f6ac62b23e608a507e08123efba3b0f7e0d)).
- 准备发布 0.1.1 ([7e2baf8](https://gitlab.com/pawamoy/gitolog/commit/7e2baf87987962ba28a7e3d958bb4328e9dd8914)).
## [0.1.0](https://gitlab.com/pawamoy/gitolog/tags/0.1.0) ([compare](https://gitlab.com/pawamoy/gitolog/compare/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446...0.1.0)) - 2018-06-27
### 新增
- 添加 github/gitlab 正则表达式 ([584fd73](https://gitlab.com/pawamoy/gitolog/commit/584fd73ec88ac51abbf8555d8f78b7144529e6b3)).
### 修复
- 修复补丁版本增加 ([8470e69](https://gitlab.com/pawamoy/gitolog/commit/8470e695128d9892296acdd31c404d85add68983)).
- 修复引用解析 ([8c77cb7](https://gitlab.com/pawamoy/gitolog/commit/8c77cb736971473837384a8238c3c53886d77c75)).
### 其他
- 继续打包 (#6) ([a29af2c](https://gitlab.com/pawamoy/gitolog/commit/a29af2cf990edf950b55a46ebea164ab068c9aec)).
- 完成打包 (#6) ([e92b492](https://gitlab.com/pawamoy/gitolog/commit/e92b4923a60d561c38150331dac9cd2e3ba6c130)).
- 实现引用解析 ([a9b4a89](https://gitlab.com/pawamoy/gitolog/commit/a9b4a89cd2737056166feb7a46da971549f1ffed)).
- 改进 angular 模板,改进 style/refs 系统 ([5b87d48](https://gitlab.com/pawamoy/gitolog/commit/5b87d48acdf3aa0f5cc2731f48e372c4065d9f9b)).
- 初始提交 ([83845fe](https://gitlab.com/pawamoy/gitolog/commit/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446)).
- 打包代码 (#6) ([1219eaf](https://gitlab.com/pawamoy/gitolog/commit/1219eafd02521f6f6ab942a02b7a7aee3d664143)).
- 更新版本 0.1.0 的变更日志 ([14edcaf](https://gitlab.com/pawamoy/gitolog/commit/14edcaf078d02c42abf1692664c620c509df88a0)).
- 更新版本 0.1.0 的变更日志 ([610633d](https://gitlab.com/pawamoy/gitolog/commit/610633da8a569e7f2966f1675a30aca651563e0b)).
- 更新版本 0.1.0 的变更日志 ([2eaaa2e](https://gitlab.com/pawamoy/gitolog/commit/2eaaa2e76fc35d111517ecd0a15daf65e705723c)).
- 进行中 ([27a60e8](https://gitlab.com/pawamoy/gitolog/commit/27a60e80e9a8308b88942311184346b1bfa4b0a8)).
自动变更日志生成器。从git日志到变更日志。
- 安装:`sudo pip3 install gitolog`
- 特性
- [Jinja2][jinja2] 模板!
你可以完全控制渲染。
内置 [Keep a Changelog][keep-a-changelog] 和 [Angular][angular] 模板
(也见 [Conventional Changelog][conventional-changelog])。
- 提交样式/约定的解析。
内置 [Angular][angular-style], [Atom][atom-style] 和基本样式。
- Git服务/提供者无关,
加上引用解析(问题、提交等)。
内置 [GitHub][github-refs] 和 [Gitlab][gitlab-refs] 支持。
- 理解 [语义化版本控制][semantic-versioning]
版本和提交的major/minor/patch。
基于最后提交猜测下一个版本。
- 待办事项
- [插件架构][issue-7],
以支持更多提交样式和Git服务。
- [模板上下文注入][issue-4],
进一步自定义你的变更日志的渲染方式。
- [在模板中轻松访问“重大变更”][issue-1]。
- [就地更新变更日志][issue-2],与
[提交/日期/版本范围限制能力][issue-3] 配对。
## 命令行
```console
$ gitolog --help
用法:gitolog [-h] [-o 输出] [-s {angular,atom,basic}]
[-t {angular,keepachangelog}] [-v]
REPOSITORY
gitolog Python 包的命令行工具。
位置参数
REPOSITORY 仓库路径,相对或绝对。
可选参数
-h, --help 显示此帮助信息并退出。
-o 输出, --output 输出
输出到指定的文件。默认:标准输出。
-s {angular,atom,basic}, --style {angular,atom,basic}
要匹配的提交风格。
-t {angular,keepachangelog}, --template {angular,keepachangelog}
要使用的 Jinja2 模板。使用 "path:" 前缀来
指定包含名为 "changelog.md" 文件的目录的路径。
-v, --version 显示程序的当前版本并退出。
```
[jinja2]: http://jinja.pocoo.org/
[keep-a-changelog]: http://keepachangelog.com/en/1.0.0/
[angular]: https://github.com/angular/angular/blob/master/CHANGELOG.md
[conventional-changelog]: https://github.com/conventional-changelog/conventional-changelog
[semantic-versioning]: http://semver.org/spec/v2.0.0.html
[atom-style]: https://github.com/atom/atom/blob/master/CONTRIBUTING.md#git-commit-messages
[angular-style]: https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit
[github-refs]: https://help.github.com/articles/autolinked-references-and-urls/
[gitlab-refs]: https://docs.gitlab.com/ce/user/markdown.html#special-gitlab-references
[issue-1]: https://gitlab.com/pawamoy/gitolog/issues/1
[issue-2]: https://gitlab.com/pawamoy/gitolog/issues/2
[issue-3]: https://gitlab.com/pawamoy/gitolog/issues/3
[issue-4]: https://gitlab.com/pawamoy/gitolog/issues/4
[issue-5]: https://gitlab.com/pawamoy/gitolog/issues/5
[issue-6]: https://gitlab.com/pawamoy/gitolog/issues/6
[issue-7]: https://gitlab.com/pawamoy/gitolog/issues/7
# Changelog
此项目的所有显著更改都将记录在此文件中。
格式基于 [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
并遵循 [语义化版本控制](http://semver.org/spec/v2.0.0.html)。
## [0.1.1](https://gitlab.com/pawamoy/gitolog/tags/0.1.1) ([compare](https://gitlab.com/pawamoy/gitolog/compare/0.1.0...0.1.1)) - 2018-06-27
### 修复
- 修复与 MANIFEST.in 一起构建的问题,添加许可证文件 ([013fb69](https://gitlab.com/pawamoy/gitolog/commit/013fb691826924d6f71b4159a8fa650e40324db3)).
### 其他
- 改善可读性 ([5e590f6](https://gitlab.com/pawamoy/gitolog/commit/5e590f6ac62b23e608a507e08123efba3b0f7e0d)).
- 准备发布 0.1.1 ([7e2baf8](https://gitlab.com/pawamoy/gitolog/commit/7e2baf87987962ba28a7e3d958bb4328e9dd8914)).
## [0.1.0](https://gitlab.com/pawamoy/gitolog/tags/0.1.0) ([compare](https://gitlab.com/pawamoy/gitolog/compare/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446...0.1.0)) - 2018-06-27
### 新增
- 添加 github/gitlab 正则表达式 ([584fd73](https://gitlab.com/pawamoy/gitolog/commit/584fd73ec88ac51abbf8555d8f78b7144529e6b3)).
### 修复
- 修复补丁版本增加 ([8470e69](https://gitlab.com/pawamoy/gitolog/commit/8470e695128d9892296acdd31c404d85add68983)).
- 修复引用解析 ([8c77cb7](https://gitlab.com/pawamoy/gitolog/commit/8c77cb736971473837384a8238c3c53886d77c75)).
### 其他
- 继续打包 (#6) ([a29af2c](https://gitlab.com/pawamoy/gitolog/commit/a29af2cf990edf950b55a46ebea164ab068c9aec)).
- 完成打包 (#6) ([e92b492](https://gitlab.com/pawamoy/gitolog/commit/e92b4923a60d561c38150331dac9cd2e3ba6c130)).
- 实现引用解析 ([a9b4a89](https://gitlab.com/pawamoy/gitolog/commit/a9b4a89cd2737056166feb7a46da971549f1ffed)).
- 改进 angular 模板,改进 style/refs 系统 ([5b87d48](https://gitlab.com/pawamoy/gitolog/commit/5b87d48acdf3aa0f5cc2731f48e372c4065d9f9b)).
- 初始提交 ([83845fe](https://gitlab.com/pawamoy/gitolog/commit/83845fe8d7deb85a2e093fe68a4b6a48b6d8e446)).
- 打包代码 (#6) ([1219eaf](https://gitlab.com/pawamoy/gitolog/commit/1219eafd02521f6f6ab942a02b7a7aee3d664143)).
- 更新版本 0.1.0 的变更日志 ([14edcaf](https://gitlab.com/pawamoy/gitolog/commit/14edcaf078d02c42abf1692664c620c509df88a0)).
- 更新版本 0.1.0 的变更日志 ([610633d](https://gitlab.com/pawamoy/gitolog/commit/610633da8a569e7f2966f1675a30aca651563e0b)).
- 更新版本 0.1.0 的变更日志 ([2eaaa2e](https://gitlab.com/pawamoy/gitolog/commit/2eaaa2e76fc35d111517ecd0a15daf65e705723c)).
- 进行中 ([27a60e8](https://gitlab.com/pawamoy/gitolog/commit/27a60e80e9a8308b88942311184346b1bfa4b0a8)).
项目详情
下载文件
下载您平台上的文件。如果您不确定要选择哪个,请了解更多关于 安装包 的信息。
源代码分发
此版本没有可用的源代码分发文件。请参阅生成分发归档教程。
构建的分发
gitolog-0.1.1-py3-none-any.whl (14.7 kB 查看哈希值)
关闭
gitolog-0.1.1-py3-none-any.whl的哈希值
算法 | 哈希摘要 | |
---|---|---|
SHA256 | a0b13982be9c67bdf503963a80778b92ea3c0635143f7f8ba53347b4a7196c87 |
|
MD5 | 6edb9c7230f8b627fe596c4abffef940 |
|
BLAKE2b-256 | 400c8af62c8ef2ad702e9c9f8174b3d5db0dbe0e20da3a9308dba82278a58d85 |