Git Changelog

支持多个模板的简单发布变更日志报告工具。

功能

• 支持多种输出模板
• Handlebars 模板语言支持
• 从输出中排除机器人噪声（Dependabot等）

用法

您可以通过运行带有 --help 参数的命令来获取用法详情

./git-chlog --help

USAGE:
    git-chlog [FLAGS] [OPTIONS] <range>

ARGS:
    <range>    Commit range, i.e. master..develop

FLAGS:
    -h, --help       Prints help information
    -v, --verbose    Verbose output
    -V, --version    Prints version information

OPTIONS:
    -c, --config <path>          Sets a custom config file [default: default.conf]
    -d, --dir <path>             Working directory [default: .]
    -n, --max-count <number>     Limit the number of commits to output
    -o, --output <output>        Output file, will use console output if not defined
        --skip <number>          Skip number commits before starting to show the commit output
    -t, --template <template>    Path to the custom output template

用法示例

# generate release log with markdown format using changes between develop and master branches
./git-chlog -d ~/github/my-app master..develop > v1.md

# generate release log with HTML format using changes between develop and master branches
./git-chlog -d ~/github/my-app master..develop -t ./assets/templates/html.hbs > v1.html

模板

该工具支持 Handlebars模板语言。

输出模板

• Markdown（默认）（assets/templates/md.hbs）
• HTML（assets/templates/html.hbs）

简单的Markdown模板示例如下

# Changelog

{{#each commits as |commit|}}
 - [{{commit.hash}}]({{../repo_url}}/commit/{{commit.hash}}) {{commit.subject}}
{{/each}}

构建

# debug build
cargo build

# release build
cargo build --release

许可证

MIT许可证，更多详情请见许可证。