overcast 0.1.3

Strongly typed changelogs for projects as changeable as the weather
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
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133

use crate::Changelog;
use askama::Template;

#[derive(Template)]
#[template(path = "markdown.md", whitespace = "minimize")]
pub struct Markdown<'a> {
    changelog: &'a Changelog,
}

/// Render a changelog as a markdown document
pub fn render_markdown(changelog: &Changelog) -> Result<String, askama::Error> {
    Markdown { changelog }.render()
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::release::Release;
    use crate::Change;
    use expect_test::expect;

    #[test]
    fn test_simple_output() {
        let changelog = Changelog::new("Test Changelog");

        let rendered = render_markdown(&changelog).unwrap();

        expect![[r#"
            # Test Changelog



        "#]]
        .assert_eq(&rendered)
    }

    #[test]
    fn test_header_rendering() {
        let changelog = Changelog::new("Test Changelog")
            .with_description("Test Description")
            .add_semantic_versioning_message()
            .add_keep_a_changelog_message();

        let rendered = render_markdown(&changelog).unwrap();

        expect![[r#"
            # Test Changelog

            Test Description

            The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

        "#]]
        .assert_eq(&rendered)
    }

    #[test]
    fn test_realease_rendering() {
        let changelog = Changelog::new("Test Changelog")
            .add_release(
                Release::unreleased()
                    .added(Change::new("Amazing feature").with_ticket_id("123"))
                    .added("Incredible bug!")
                    .fixed("Nothing"),
            )
            .add_release(
                Release::new(0, 1, 0)
                    .added("A")
                    .changed("B")
                    .deprecated("C")
                    .removed("D")
                    .fixed("E")
                    .security("F"),
            )
            .add_release(
                Release::new(2, 4, 0)
                    .with_date(1976, 5, 12)
                    .deprecated("The one useful feature you needed from this thing")
                    .yank(),
            );

        let rendered = render_markdown(&changelog).unwrap();

        expect![[r#"
            # Test Changelog



            ## Unreleased

            ### Added
            - Amazing feature (#123)

            - Incredible bug!


            ### Fixed
            - Nothing

            ## 0.1.0

            ### Added
            - A


            ### Changed
            - B


            ### Deprecated
            - C


            ### Removed
            - D


            ### Fixed
            - E


            ### Security
            - F

            ## 2.4.0 - 1976-05-12 - [YANKED]

            ### Deprecated
            - The one useful feature you needed from this thing

        "#]]
        .assert_eq(&rendered)
    }
}