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
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
pub use crate::errors::Error;
use crate::{
extractors::{Extractor, RepoInformation},
github::{github_link_for_commit, github_link_for_issue, github_link_for_range},
utils::pairwise,
};
use chrono::{DateTime, NaiveDateTime, Utc};
use git2::Repository;
use markdown_composer::{
traits::MarkdownElement, transforms::Bold, Link, List, Markdown, PRELIMINARY_REMARK,
};
use semver::{SemVerError, Version};
use std::{cmp::Ordering, error::Error as StdError, path::Path};
mod errors;
mod extractors;
mod github;
mod utils;
fn populate_changelog_from_commits(
commits: Vec<&(&git2::Commit, conventional_commits_parser::Commit)>,
repo_info: &RepoInformation,
) -> Result<List, Box<dyn StdError>> {
let mut list = List::unordered();
for (commit, p) in commits {
let mut item = match p.scope {
Some(scope) => format!("{}: {}", scope.bold(), p.desc),
None => p.desc.to_string(),
};
let mut additions = Vec::with_capacity(2);
let short_hash = commit.as_object().short_id()?;
let short_hash = short_hash.as_str().unwrap();
let hash_link = Link::builder()
.text(short_hash)
.url(github_link_for_commit(&commit.id().to_string(), &repo_info))
.inlined()
.build();
additions.push(format!("({})", hash_link));
for footer in &p.footer {
match footer.token {
"Fixes" | "Closes" => {
let issue_link = Link::builder()
.text(format!("#{}", footer.value))
.url(github_link_for_issue(footer.value, &repo_info))
.inlined()
.build();
additions.push(format!(", closes {}", issue_link));
}
_ => {}
}
}
if !additions.is_empty() {
let joined_additions = format!(" {}", additions.join(" "));
item.push_str(&joined_additions);
}
list.add(Box::new(item));
}
Ok(list)
}
pub fn generate_changelog(repo_dir: impl AsRef<Path>) -> Result<Markdown, Box<dyn StdError>> {
let repo_dir_path = repo_dir.as_ref();
let repo = Repository::open(repo_dir_path);
if let Err(e) = repo {
return Err(Box::new(Error::NoGitRepository {
path: repo_dir_path.display().to_string(),
source: e,
}));
};
let repo = repo.unwrap();
let tag_names = repo.tag_names(Some("v*"))?;
let mut tag_to_semver_mapped: Vec<(&str, Version)> = tag_names
.iter()
.flatten()
.map(|v: &str| {
let trimmed = v.trim_start_matches('v');
(v, trimmed)
})
.map::<Result<(&str, Version), SemVerError>, _>(|(tag, semver)| {
Ok((tag, Version::parse(semver)?))
})
.flatten()
.collect::<Vec<_>>();
tag_to_semver_mapped.sort_by(|a, b| {
if a.0 == "HEAD" {
return Ordering::Greater;
}
a.1.cmp(&b.1)
});
let tag_names = tag_to_semver_mapped
.iter()
.map(|(tag, _)| tag)
.collect::<Vec<_>>();
let latest_tag = tag_names[tag_names.len() - 1];
let tag_range_pairs = pairwise(tag_names)
.chain(std::iter::once((latest_tag, &"HEAD")))
.collect::<Vec<_>>();
let mut extractors = Vec::new();
for extractor in inventory::iter::<&dyn Extractor> {
extractors.push(extractor);
}
extractors.sort_by_key(|e| e.priority());
let mut repo_info = None;
for extractor in extractors {
if extractor.is_applicable(repo_dir_path) {
match extractor.extract_repo_information(repo_dir_path) {
Ok(info) => {
repo_info = Some(info);
break;
},
Err(e) => {
eprintln!("error: {:?}", e);
}
};
}
}
let repo_info = repo_info.expect("failed to retrieve repo info");
let mut changelog = Markdown::new();
changelog.header1("Changelog");
for line in &*PRELIMINARY_REMARK {
changelog.paragraph(line.render());
}
for (from, to) in tag_range_pairs.into_iter().rev() {
let diff_link = github_link_for_range(from, to, &repo_info);
let diff_link = Link::builder().text(*to).url(diff_link).inlined().build();
let mut rendered_diff_link = diff_link.render();
let to_tag_ref = repo.resolve_reference_from_short_name(to)?;
let to_tag_date_string = if to_tag_ref.is_tag() {
let tag = to_tag_ref.peel_to_commit()?;
let time = tag.time();
let time = NaiveDateTime::from_timestamp(time.seconds(), 0);
let time: DateTime<Utc> = DateTime::from_utc(time, Utc);
time.format("%Y-%m-%d").to_string()
} else if to_tag_ref.is_branch() && *to == "HEAD" {
let time: DateTime<Utc> = Utc::now();
time.format("%Y-%m-%d").to_string()
} else {
String::with_capacity(0)
};
if !rendered_diff_link.is_empty() {
rendered_diff_link.push_str(&format!(" ({})", to_tag_date_string));
}
let stripped = to.trim_start_matches('v');
let level: usize = if stripped == "HEAD" {
1
} else {
let version = Version::parse(&stripped)?;
if version.patch == 0 {
1
} else {
2
}
};
changelog.header(rendered_diff_link, level);
let rev = format!("{}..{}", from, to);
let commits = conventional_commits_next_semver::git_commits_in_range(&repo, &rev)?;
let commits = commits
.into_iter()
.map(|oid| repo.find_commit(oid))
.filter_map(Result::ok)
.collect::<Vec<_>>();
let parsed_messages = commits
.iter()
.map(|c| {
if let Some(msg) = c.message() {
let parsed_msg = conventional_commits_parser::parse_commit_msg(msg);
if let Ok(parsed_msg) = parsed_msg {
return Some((c, parsed_msg));
}
}
None
})
.filter_map(|t| t)
.collect::<Vec<_>>();
let (fixes, other): (Vec<_>, Vec<_>) = parsed_messages
.iter()
.partition(|(_, parsed)| parsed.ty == "fix");
let (features, _other): (
Vec<&(&git2::Commit, conventional_commits_parser::Commit)>,
Vec<&(&git2::Commit, conventional_commits_parser::Commit)>,
) = other.iter().partition(|(_, parsed)| parsed.ty == "feat");
if !fixes.is_empty() {
changelog.header3("Bug Fixes");
changelog.list(populate_changelog_from_commits(fixes, &repo_info)?);
}
if !features.is_empty() {
changelog.header3("Features");
changelog.list(populate_changelog_from_commits(features, &repo_info)?);
}
}
Ok(changelog)
}