Crate cclog 

cclog

A conventional changelog generator for the rest of us.

This is a fork of clog-lib and clog-cli, merged into a single Cargo workspace.

Crate	Description
cclog	Library for generating a conventional changelog from git metadata
cclog-cli	Command-line interface wrapping the library

Library usage

Add cclog to your Cargo.toml:

[dependencies]
cclog = "0.12"

use cclog::Clog;

fn main() {
    let clog = Clog::with_git_work_tree(".")
        .unwrap()
        .repository("https://github.com/user/repo")
        .subtitle("My Release")
        .changelog("CHANGELOG.md")
        .from("v0.1.0")
        .version("0.2.0");

    clog.write_changelog().unwrap();
}

CLI usage

cargo install cclog-cli
cclog --help

Or build from source:

cargo build --release -p cclog-cli

Configuration

cclog can be configured using a .clog.toml file. See lib/examples/clog.toml for available options.

Related projects

• Commitizen — helps you write better commit messages.

License

MIT — see LICENSE for details.

Modules

error

fmt

git

Structs

Clog

The base struct used to set options and interact with the library.

SectionMap

A struct which holds sections to and components->commits map

Enums

LinkStyle

Determines the hyperlink style used in commit and issue links. Defaults to LinksStyle::Github