Lib.rs

clog

一个用于从 Git 元数据生成常规变更日志的库，用 Rust 编写

关于

clog 可以从您的本地 Git 元数据自动创建变更日志。有关示例，请参阅 clog 的 changelog.md。

此方式的工作原理是，每次您提交代码时，都确保您的提交主题行遵循 常规 格式。

注意： clog 也支持通过使提交消息为 alias: message 或 alias(): message（即没有组件）来创建空组件。

使用方法

使用 clog 有两种方式，通过命令行作为二进制文件（有关详细信息，请参阅 clog-cli）或在您的应用程序中作为库。

有关在您的应用程序中使用 clog 的信息，请参阅 文档。

要查看其实际效果，您需要一个已经包含一些特殊定制的提交消息的历史记录的仓库。为此，我们将使用 clog 仓库本身。

1. 克隆 clog-lib 仓库（我们将克隆到我们的主目录以简化操作，您可以根据需要更改它）

$ git clone https://github.com/clog-tool/clog-lib

2. 在您的 Cargo.toml 中添加 clog 依赖项

[dependencies]
clog = "*"

3. 在您的 src/main.rs 中使用以下内容

extern crate clog;

use clog::Clog;

fn main() {
    // Create the struct
    let mut clog = Clog::with_git_work_tree("~/clog")
        .unwrap()
        .repository("https://github.com/thoughtram/clog")
        .subtitle("Crazy Dog")
        .changelog("changelog.md")
        .from("6d8183f")
        .version("0.1.0");

    // Write the changelog to the current working directory
    //
    // Alternatively we could have used .write_changelog_to("/somedir/some_file.md")
    clog.write_changelog().unwrap();
}

4. 编译并运行 `$ cargo build --release && ./target/release/bin_name
5. 在您最喜欢的 Markdown 查看器中查看输出！ $ vim changelog.md

配置

clog 还可以通过 TOML 配置文件进行配置。

有关可用选项，请参阅 examples/clog.toml。

配套项目

• clog-cli - 一个使用此库生成变更日志的命令行工具。
• Commitizen - 一个帮助你编写更好的提交信息的命令行工具。

许可证

clog 采用 MIT 开源许可证。有关更多信息，请参阅本存储库中的 LICENSE 文件。