diff options
author | Laurențiu Nicola <[email protected]> | 2021-03-29 06:55:43 +0100 |
---|---|---|
committer | Laurențiu Nicola <[email protected]> | 2021-04-20 17:54:58 +0100 |
commit | 39ce393a9e5a71aa410923b22e67968a91c00582 (patch) | |
tree | 95cf80d1b805e4af2ec936b4f561ea0ff0d65fb4 /xtask/src/release | |
parent | ad131049c4cd1302af1a5616ff83d0e1f0cadea2 (diff) |
Automatically categorize the changelog entries
Diffstat (limited to 'xtask/src/release')
-rw-r--r-- | xtask/src/release/changelog.rs | 159 |
1 files changed, 159 insertions, 0 deletions
diff --git a/xtask/src/release/changelog.rs b/xtask/src/release/changelog.rs new file mode 100644 index 000000000..ffcae2cf7 --- /dev/null +++ b/xtask/src/release/changelog.rs | |||
@@ -0,0 +1,159 @@ | |||
1 | use std::fmt::Write; | ||
2 | use std::{env, iter}; | ||
3 | |||
4 | use anyhow::{bail, Result}; | ||
5 | use xshell::cmd; | ||
6 | |||
7 | pub(crate) fn get_changelog( | ||
8 | changelog_n: usize, | ||
9 | commit: &str, | ||
10 | prev_tag: &str, | ||
11 | today: &str, | ||
12 | ) -> Result<String> { | ||
13 | let git_log = cmd!("git log {prev_tag}..HEAD --merges --reverse").read()?; | ||
14 | let mut features = String::new(); | ||
15 | let mut fixes = String::new(); | ||
16 | let mut internal = String::new(); | ||
17 | let mut others = String::new(); | ||
18 | for line in git_log.lines() { | ||
19 | let line = line.trim_start(); | ||
20 | if let Some(p) = line.find(':') { | ||
21 | let pr = &line[..p]; | ||
22 | if let Ok(pr_num) = pr.parse::<u32>() { | ||
23 | let accept = "Accept: application/vnd.github.v3+json"; | ||
24 | let token = match env::var("GITHUB_TOKEN") { | ||
25 | Ok(token) => token, | ||
26 | Err(_) => bail!("Please obtain a personal access token from https://github.com/settings/tokens and set the `GITHUB_TOKEN` environment variable."), | ||
27 | }; | ||
28 | let authorization = format!("Authorization: token {}", token); | ||
29 | let pr_url = "https://api.github.com/repos/rust-analyzer/rust-analyzer/issues"; | ||
30 | |||
31 | // we don't use an HTTPS client or JSON parser to keep the build times low | ||
32 | let pr_json = | ||
33 | cmd!("curl -s -H {accept} -H {authorization} {pr_url}/{pr}").read()?; | ||
34 | let pr_title = cmd!("jq .title").stdin(&pr_json).read()?; | ||
35 | let pr_title = unescape(&pr_title[1..pr_title.len() - 1]); | ||
36 | let pr_comment = cmd!("jq .body").stdin(pr_json).read()?; | ||
37 | |||
38 | let comments_json = | ||
39 | cmd!("curl -s -H {accept} -H {authorization} {pr_url}/{pr}/comments").read()?; | ||
40 | let pr_comments = cmd!("jq .[].body").stdin(comments_json).read()?; | ||
41 | |||
42 | let l = iter::once(pr_comment.as_str()) | ||
43 | .chain(pr_comments.lines()) | ||
44 | .rev() | ||
45 | .find_map(|it| { | ||
46 | let it = unescape(&it[1..it.len() - 1]); | ||
47 | it.lines().find_map(parse_changelog_line) | ||
48 | }) | ||
49 | .into_iter() | ||
50 | .next() | ||
51 | .unwrap_or_else(|| parse_title_line(&pr_title)); | ||
52 | let s = match l.kind { | ||
53 | PrKind::Feature => &mut features, | ||
54 | PrKind::Fix => &mut fixes, | ||
55 | PrKind::Internal => &mut internal, | ||
56 | PrKind::Other => &mut others, | ||
57 | PrKind::Skip => continue, | ||
58 | }; | ||
59 | writeln!(s, "* pr:{}[] {}", pr_num, l.message.as_deref().unwrap_or(&pr_title)) | ||
60 | .unwrap(); | ||
61 | } | ||
62 | } | ||
63 | } | ||
64 | |||
65 | let contents = format!( | ||
66 | "\ | ||
67 | = Changelog #{} | ||
68 | :sectanchors: | ||
69 | :page-layout: post | ||
70 | |||
71 | Commit: commit:{}[] + | ||
72 | Release: release:{}[] | ||
73 | |||
74 | == Sponsors | ||
75 | |||
76 | **Become a sponsor:** On https://opencollective.com/rust-analyzer/[OpenCollective] or | ||
77 | https://github.com/sponsors/rust-analyzer[GitHub Sponsors]. | ||
78 | |||
79 | == New Features | ||
80 | |||
81 | {} | ||
82 | |||
83 | == Fixes | ||
84 | |||
85 | {} | ||
86 | |||
87 | == Internal Improvements | ||
88 | |||
89 | {} | ||
90 | |||
91 | == Others | ||
92 | |||
93 | {} | ||
94 | ", | ||
95 | changelog_n, commit, today, features, fixes, internal, others | ||
96 | ); | ||
97 | Ok(contents) | ||
98 | } | ||
99 | |||
100 | #[derive(Clone, Copy)] | ||
101 | enum PrKind { | ||
102 | Feature, | ||
103 | Fix, | ||
104 | Internal, | ||
105 | Other, | ||
106 | Skip, | ||
107 | } | ||
108 | |||
109 | struct PrInfo { | ||
110 | message: Option<String>, | ||
111 | kind: PrKind, | ||
112 | } | ||
113 | |||
114 | fn unescape(s: &str) -> String { | ||
115 | s.replace(r#"\""#, "").replace(r#"\n"#, "\n").replace(r#"\r"#, "") | ||
116 | } | ||
117 | |||
118 | fn parse_changelog_line(s: &str) -> Option<PrInfo> { | ||
119 | let parts = s.splitn(3, ' ').collect::<Vec<_>>(); | ||
120 | if parts.len() < 2 || parts[0] != "changelog" { | ||
121 | return None; | ||
122 | } | ||
123 | let message = parts.get(2).map(|it| it.to_string()); | ||
124 | let kind = match parts[1].trim_end_matches(':') { | ||
125 | "feature" => PrKind::Feature, | ||
126 | "fix" => PrKind::Fix, | ||
127 | "internal" => PrKind::Internal, | ||
128 | "skip" => PrKind::Skip, | ||
129 | _ => { | ||
130 | let kind = PrKind::Other; | ||
131 | let message = format!("{} {}", parts[1], message.unwrap_or_default()); | ||
132 | return Some(PrInfo { kind, message: Some(message) }); | ||
133 | } | ||
134 | }; | ||
135 | let res = PrInfo { kind, message }; | ||
136 | Some(res) | ||
137 | } | ||
138 | |||
139 | fn parse_title_line(s: &str) -> PrInfo { | ||
140 | let lower = s.to_ascii_lowercase(); | ||
141 | const PREFIXES: [(&str, PrKind); 5] = [ | ||
142 | ("feat: ", PrKind::Feature), | ||
143 | ("feature: ", PrKind::Feature), | ||
144 | ("fix: ", PrKind::Fix), | ||
145 | ("internal: ", PrKind::Internal), | ||
146 | ("minor: ", PrKind::Skip), | ||
147 | ]; | ||
148 | |||
149 | for &(prefix, kind) in &PREFIXES { | ||
150 | if lower.starts_with(prefix) { | ||
151 | let message = match &kind { | ||
152 | PrKind::Skip => None, | ||
153 | _ => Some(s[prefix.len()..].to_string()), | ||
154 | }; | ||
155 | return PrInfo { kind, message }; | ||
156 | } | ||
157 | } | ||
158 | PrInfo { kind: PrKind::Other, message: Some(s.to_string()) } | ||
159 | } | ||