-
-
Notifications
You must be signed in to change notification settings - Fork 287
/
generate_release_notes.py
executable file
·292 lines (252 loc) · 9.11 KB
/
generate_release_notes.py
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
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
#!/usr/bin/env python3
"""Generate release notes using git log or GitHub API
Needs PyYAML, Git, and GitHub CLI.
"""
import argparse
import csv
import json
import re
import subprocess
import sys
from collections import defaultdict
import yaml
PRETTY_TEMPLATE = (
" - hash: %H%n"
" author_name: %aN%n"
" author_email: %aE%n"
" date: %ad%n"
" message: |-%n %s"
)
def remove_excluded_changes(changes, exclude):
"""Return a list of changes with excluded changes removed"""
result = []
for change in changes:
include = True
for expression in exclude["regexp"]:
if re.match(expression, change):
include = False
break
if include:
result.append(change)
return result
def round_down_to_five(value):
"""Round down to the nearest multiple of five"""
base = 5
return value - (value % base)
def split_to_categories(changes, categories):
"""Return dictionary of changes divided into categories
*categories* is a list of dictionaries (mappings) with
keys title and regexp.
"""
by_category = defaultdict(list)
for change in changes:
added = False
for category in categories:
if re.match(category["regexp"], change):
by_category[category["title"]].append(change)
added = True
break
if not added:
by_category["Other Changes"].append(change)
return by_category
def print_category(category, changes, file=None):
"""Print changes for one category from dictionary of changes
If *changes* don't contain a given category, nothing is printed.
"""
items = changes.get(category, None)
if not items:
return
print(f"### {category}", file=file)
for item in sorted(items):
print(f"* {item}", file=file)
print("")
def print_by_category(changes, categories, file=None):
"""Print changes by categories from dictionary of changes"""
for category in categories:
print_category(category["title"], changes, file=file)
print_category("Other Changes", changes, file=file)
def binder_badge(tag):
"""Get mybinder Binder badge from a given tag, hash, or branch"""
binder_image_url = "https://camo.githubusercontent.com/581c077bdbc6ca6899c86d0acc6145ae85e9d80e6f805a1071793dbe48917982/68747470733a2f2f6d7962696e6465722e6f72672f62616467655f6c6f676f2e737667" # noqa
binder_url = f"https://mybinder.org/v2/gh/OSGeo/grass/{tag}?urlpath=lab%2Ftree%2Fdoc%2Fnotebooks%2Fbasic_example.ipynb" # noqa
return f"[![Binder]({binder_image_url})]({binder_url})"
def print_notes(
start_tag, end_tag, changes, categories, before=None, after=None, file=None
):
"""Print notes from given inputs
*changes* is a list of strings. It will be sorted and ordered by category
internally by this function.
"""
num_changes = round_down_to_five(len(changes))
print(
f"The GRASS GIS {end_tag} release provides more than "
f"{num_changes} improvements and fixes "
f"with respect to the release {start_tag}.\n"
)
if before:
print(before)
print("## What's Changed", file=file)
changes_by_category = split_to_categories(changes, categories=categories)
print_by_category(changes_by_category, categories=categories, file=file)
if after:
print(after)
print("")
print(binder_badge(end_tag))
def notes_from_gh_api(start_tag, end_tag, branch, categories, exclude):
"""Generate notes from GitHub API"""
text = subprocess.run(
[
"gh",
"api",
"repos/OSGeo/grass/releases/generate-notes",
"-f",
f"previous_tag_name={start_tag}",
"-f",
f"tag_name={end_tag}",
"-f",
f"target_commitish={branch}",
],
capture_output=True,
text=True,
check=True,
).stdout
body = json.loads(text)["body"]
lines = body.splitlines()
start_whats_changed = lines.index("## What's Changed")
end_whats_changed = lines.index("", start_whats_changed)
raw_changes = lines[start_whats_changed + 1 : end_whats_changed]
changes = []
for change in raw_changes:
if change.startswith("* ") or change.startswith("- "):
changes.append(change[2:])
else:
changes.append(change)
changes = remove_excluded_changes(changes=changes, exclude=exclude)
print_notes(
start_tag=start_tag,
end_tag=end_tag,
changes=changes,
before="\n".join(lines[:start_whats_changed]),
after="\n".join(lines[end_whats_changed + 1 :]),
categories=categories,
)
def csv_to_dict(filename, key, value):
"""Read a CSV file as a dictionary"""
result = {}
with open(filename, encoding="utf-8", newline="") as csvfile:
reader = csv.DictReader(csvfile)
for row in reader:
result[row[key]] = row[value]
return result
def notes_from_git_log(start_tag, end_tag, categories, exclude):
"""Generate notes from git log"""
text = subprocess.run(
["git", "log", f"{start_tag}..{end_tag}", f"--pretty=format:{PRETTY_TEMPLATE}"],
capture_output=True,
text=True,
check=True,
).stdout
commits = yaml.safe_load(text)
if not commits:
raise RuntimeError("No commits retrieved from git log (try different tags)")
svn_name_by_git_author = csv_to_dict(
"svn_name_git_author.csv", key="git_author", value="svn_name"
)
github_name_by_svn_name = csv_to_dict(
"svn_name_github_name.csv", key="svn_name", value="github_name"
)
github_name_by_git_author = csv_to_dict(
"git_author_github_name.csv", key="git_author", value="github_name"
)
lines = []
for commit in commits:
if commit["author_email"].endswith("users.noreply.github.com"):
github_name = commit["author_email"].split("@")[0]
if "+" in github_name:
github_name = github_name.split("+")[1]
github_name = f"@{github_name}"
else:
# Emails are stored with @ replaced by a space.
email = commit["author_email"].replace("@", " ")
git_author = f"{commit['author_name']} <{email}>"
if (
git_author not in svn_name_by_git_author
and git_author in github_name_by_git_author
):
github_name = github_name_by_git_author[git_author]
github_name = f"@{github_name}"
else:
try:
svn_name = svn_name_by_git_author[git_author]
github_name = github_name_by_svn_name[svn_name]
github_name = f"@{github_name}"
except KeyError:
github_name = git_author
lines.append(f"{commit['message']} by {github_name}")
lines = remove_excluded_changes(changes=lines, exclude=exclude)
print_notes(
start_tag=start_tag,
end_tag=end_tag,
changes=lines,
after=(
"**Full Changelog**: "
f"https://github.com/OSGeo/grass/compare/{start_tag}...{end_tag}"
),
categories=categories,
)
def create_release_notes(args):
"""Create release notes based on parsed command line parameters"""
end_tag = args.end_tag
if not end_tag:
# git log has default, but the others do not.
end_tag = subprocess.run(
["git", "rev-parse", "--verify", "HEAD"],
capture_output=True,
text=True,
check=True,
).stdout.strip()
with open("release.yml", encoding="utf-8") as file:
config = yaml.safe_load(file.read())["notes"]
if args.backend == "api":
notes_from_gh_api(
start_tag=args.start_tag,
end_tag=end_tag,
branch=args.branch,
categories=config["categories"],
exclude=config["exclude"],
)
else:
notes_from_git_log(
start_tag=args.start_tag,
end_tag=end_tag,
categories=config["categories"],
exclude=config["exclude"],
)
def main():
"""Parse command line arguments and create release notes"""
parser = argparse.ArgumentParser(
description="Generate release notes from git log or GitHub API.",
epilog="Run in utils directory to access the helper files.",
)
parser.add_argument(
"backend", choices=["log", "api"], help="use git log or GitHub API"
)
parser.add_argument(
"branch", help="needed for the GitHub API when tag does not exist"
)
parser.add_argument("start_tag", help="old tag to compare against")
parser.add_argument(
"end_tag",
help=(
"new tag; "
"if not created yet, "
"an empty string for git log will use the current revision"
),
)
args = parser.parse_args()
try:
create_release_notes(args)
except subprocess.CalledProcessError as error:
sys.exit(f"Subprocess '{' '.join(error.cmd)}' failed with: {error.stderr}")
if __name__ == "__main__":
main()