git-harvest 0.2.0

Harvest a CHANGELOG from your Git history.
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

/*********************** GNU General Public License 3.0 ***********************\
|                                                                              |
|  Copyright (C) 2026 Kevin Matthes                                            |
|                                                                              |
|  This program is free software: you can redistribute it and/or modify        |
|  it under the terms of the GNU General Public License as published by        |
|  the Free Software Foundation, either version 3 of the License, or           |
|  (at your option) any later version.                                         |
|                                                                              |
|  This program is distributed in the hope that it will be useful,             |
|  but WITHOUT ANY WARRANTY; without even the implied warranty of              |
|  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
|  GNU General Public License for more details.                                |
|                                                                              |
|  You should have received a copy of the GNU General Public License           |
|  along with this program.  If not, see <https://www.gnu.org/licenses/>.      |
|                                                                              |
\******************************************************************************/

//! One released, or pending, version of the CHANGELOG.

/// One section of the CHANGELOG:  the changes of a single version.
///
/// A section with no `released` moment is the pending, not-yet-published one.
/// `changes` maps a bucket name to its entries, in the order they render.
#[derive(Clone, Debug, Eq, PartialEq, serde::Deserialize, serde::Serialize)]
pub struct Section {
    /// The version this section documents, as a `(major, minor, patch)`
    /// triple in the RON.
    #[serde(with = "super::version")]
    pub version: semver::Version,

    /// The moment this version was published, or `None` while pending.
    pub released: Option<chrono::DateTime<chrono::Utc>>,

    /// An optional prose lead for this version.
    pub introduction: Option<String>,

    /// Link labels used by this section, mapped to their targets.
    pub references: std::collections::BTreeMap<String, String>,

    /// The entries of this section, keyed by bucket.
    pub changes: std::collections::BTreeMap<String, Vec<crate::Entry>>,
}

/******************************************************************************/