-
Notifications
You must be signed in to change notification settings - Fork 0
/
git_changelog_generator.py
138 lines (119 loc) · 4.36 KB
/
git_changelog_generator.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
import argparse
import re
import chevron
import git
def extract_info_from_commits(commits):
extracted_commits = []
for commit in commits:
message_lines = commit.message.splitlines()
subject = message_lines[0]
body = "\n".join(message_lines[1:])
item = dict()
item["subject"] = subject
item["commit"] = commit.hexsha
item["author_name"] = commit.author.name
item["author_email"] = commit.author.email
item["body"] = body
match_type_and_pr_num = re.search(
r"^([a-zA-Z]+)(\!?):.+\(#([0-9]+)\)$", subject
)
if match_type_and_pr_num:
item["type"] = match_type_and_pr_num.group(1)
item["breaking"] = match_type_and_pr_num.group(2) == "!"
item["pr_num"] = match_type_and_pr_num.group(3)
else:
# If type isn't found try just extracting the PR number.
match_pr_num = re.search(r"^.+\(#([0-9]+)\)$", subject)
if match_pr_num:
item["pr_num"] = match_pr_num.group(1)
item["breaking"] = False
item["type"] = "unknown"
else:
item["type"] = "unknown"
item["breaking"] = False
item["pr_num"] = "unknown"
extracted_commits.append(item)
return extracted_commits
def extract_authors_from_commits(commits):
authors_seen = set()
authors = []
for commit in commits:
if commit.author.name not in authors_seen:
authors.append({"name": commit.author.name, "email": commit.author.email})
authors_seen.add(commit.author.name)
return authors
def main():
parser = argparse.ArgumentParser(
description="Extract commits from a git repo and format according to template"
)
parser.add_argument(
"--file", "-f", type=str, required=True, help="Template file to process"
)
parser.add_argument(
"--range",
"-r",
type=str,
required=True,
help="git log range to extract commits for",
)
parser.add_argument(
"--dir",
"-d",
type=str,
required=True,
help="directory of repo to read commits from",
)
parser.add_argument(
"--additional_data",
"-c",
type=str,
default=[],
action="append",
help="Additional data values pass to template, must be in the form key=value",
)
args = parser.parse_args()
repo = git.Repo(args.dir)
commit_list = list(repo.iter_commits(args.range, max_count=None))
commits_with_extracted_info = extract_info_from_commits(commit_list)
authors = extract_authors_from_commits(commit_list)
def commits_by_type(commit_type):
return [
commit
for commit in commits_with_extracted_info
if commit["type"] == commit_type
]
data = {
"commits": commits_with_extracted_info,
"authors": authors,
"unknown_type_commits": commits_by_type("unknown"),
"feat_type_commits": commits_by_type("feat"),
"fix_type_commits": commits_by_type("fix"),
"docs_type_commits": commits_by_type("docs"),
"style_type_commits": commits_by_type("style"),
"refactor_type_commits": commits_by_type("refactor"),
"perf_type_commits": commits_by_type("perf"),
"test_type_commits": commits_by_type("test"),
"build_type_commits": commits_by_type("build"),
"ci_type_commits": commits_by_type("ci"),
"chore_type_commits": commits_by_type("chore"),
"revert_type_commits": commits_by_type("revert"),
}
template_file = args.file
with open(template_file, "r") as f:
template_contents = f.read()
for val in args.additional_data:
if "=" in val and val.count("=") == 1:
components = val.split("=")
if components[0] in data:
raise RuntimeError(
f"{components[0]} already defined in template data"
)
data[components[0]] = components[1]
else:
raise RuntimeError(
f"--additional_data must be of the form key=value, but found: {val}"
)
rendered = chevron.render(template=template_contents, data=data)
print(rendered)
if __name__ == "__main__":
main()