changelog_document 0.1.7

Feature-rich changelog format. Include a parser and serializer.
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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108

use std::collections::BTreeMap;

use indexmap::IndexMap;

pub mod de;
pub mod fmt;
pub mod ser;
pub mod utils;
mod version;
pub use semver;
pub use version::Version;

#[cfg(test)]
mod test;

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ReleaseTitle {
    pub version: String,
    pub release_link: Option<String>,
    pub title: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ReleaseSection {
    pub title: String,
    pub notes: Vec<ReleaseSectionNote>,
}

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
pub struct ReleaseSectionNote {
    pub scope: Option<String>,
    pub message: String,
    pub context: Vec<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Release {
    pub title: ReleaseTitle,
    pub header: Option<String>,
    pub note_sections: IndexMap<String, ReleaseSection>,
    pub footer: Option<String>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct FooterLink {
    pub text: String,
    pub link: String,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct FooterLinks {
    pub links: Vec<FooterLink>,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct ChangeLog {
    pub header: Option<String>,
    pub unreleased: Option<Release>,
    /// Release, sorted by 0.0.0 to 1.0.0
    pub releases: BTreeMap<Version, Release>,
    pub footer_links: FooterLinks,
}

impl Default for ChangeLog {
    fn default() -> Self {
        Self::new()
    }
}

impl ChangeLog {
    pub fn new() -> Self {
        let mut releases = BTreeMap::new();

        let unreleased = Release {
            title: ReleaseTitle {
                version: String::from("Unreleased"),
                title: None,
                release_link: None,
            },
            header: None,
            note_sections: IndexMap::new(),
            footer: None,
        };

        let version = Version::new(0, 1, 0);

        releases.insert(
            version.clone(),
            Release {
                title: ReleaseTitle {
                    version: version.to_string(),
                    title: None,
                    release_link: None,
                },
                header: None,
                note_sections: IndexMap::new(),
                footer: None,
            },
        );

        ChangeLog {
            header: None,
            unreleased: Some(unreleased),
            releases,
            footer_links: FooterLinks { links: Vec::new() },
        }
    }
}