git-changelog 0.3.1

A tool to automate project changelog generation.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

extern crate changelog;
extern crate difference;
extern crate env_logger;
extern crate log;

use changelog::*;

#[test]
fn readme_example() {
    let config = builtin_config();
    let commits = vec![readme_commit()];
    let mut log = ChangeLog::from(commits.into_iter(), &config);
    log.range = String::from("1d82af9^..1d82af9");
    let md = render(&log, &config.output).unwrap();
    let expected = include_str!("../src/assets/sample.md");
    let diff = difference::Changeset::new(expected, &md, " ");
    assert_eq!(diff.diffs.len(), 1, "{:#?}", diff.diffs);
}

#[test]
fn library_example() {
    // Create a custom configuration
    let mut config = Configuration::new();

    // Pick the category or scope keywords that match your project conventions
    config
        .conventions
        .categories
        .push(Keyword::new("feature", "New Features"));
    config
        .conventions
        .categories
        .push(Keyword::new("break", "Breaking Changes"));

    // Pick the range of commits
    let range = "v0.1.1..v0.2.0";

    // Generate a changelog for the range with the configuration
    let changelog = ChangeLog::from_range(range, &config);

    // Print
    println!("{}", changelog);
    println!("{:#?}", changelog);
}

fn builtin_config() -> Configuration {
    Configuration::from_yaml(include_str!("../src/assets/changelog.yml")).unwrap()
}

fn readme_commit() -> Commit {
    let mut commit = vec![
        "1d82af9a1bd05c100b7b50bdcda3db39a5cddcdf",
        "aaaaaa a a'aaaaa",
        "Sun, 22 Oct 2017 17:26:56 -0400",
    ];
    commit.extend(include_str!("../src/assets/sample-commit.message").lines());
    let commit: Vec<String> = commit.into_iter().map(str::to_string).collect();
    Commit::from_lines(commit)
}