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

use crate::Changelog;

/// Render a changelog into a JSON string representation
pub fn render_json(changelog: &Changelog) -> Result<String, serde_json::Error> {
    serde_json::to_string_pretty(changelog)
}

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

    #[test]
    fn test_render_changelog() {
        let changelog = get_overcast_changelog();

        let json = render_json(&changelog).unwrap();

        expect![[r#"
            {
              "title": "Overcast",
              "description": "Statically typed changelogs for projects as changeable as the weather",
              "releases": {
                "0.1.0": {
                  "summary": "Initial Release of Overcast",
                  "version": "0.1.0",
                  "added": [
                    {
                      "description": "Basic Keep A Changelog structure",
                      "ticket_id": null
                    },
                    {
                      "description": "Example to render Overcast's changelog",
                      "ticket_id": null
                    },
                    {
                      "description": "Markdown rendering",
                      "ticket_id": null
                    }
                  ],
                  "changed": [],
                  "deprecated": [],
                  "removed": [],
                  "fixed": [],
                  "security": [],
                  "yanked": false,
                  "date": "2024-03-19"
                }
              },
              "keep_a_changelog_message": true,
              "semantic_versioning_message": true
            }"#]].assert_eq(&json);
    }
}