-
Notifications
You must be signed in to change notification settings - Fork 0
/
release_actions.py
219 lines (178 loc) · 7.96 KB
/
release_actions.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
#!/usr/bin/env python3
import re
import subprocess
from argparse import ArgumentParser, Namespace
from pathlib import Path
from string import Template
from typing import Literal, NamedTuple, get_args as get_type_args
ReleaseMode = Literal["major", "minor", "patch"]
EventName = Literal["push", "create", "pull_request"]
_ZERO_PAD_PATTERN = re.compile(r"0\d")
_RELEASE_MODES = list(get_type_args(ReleaseMode))
_RELEASE_BRANCH_PATTERN = re.compile(rf"^release-(?P<mode>{'|'.join(_RELEASE_MODES)})(-(?P<project>\d\d\d\d))?$")
_MASTER_BRANCH = "master"
class ReleaseActionsError(Exception):
pass
def _check_output(*commands: str) -> str:
output = subprocess.check_output(commands).decode("utf-8")
return output.strip() if output else ""
def _git(*commands: str) -> str:
return _check_output("git", *commands)
def _increase_version(version: str, mode: ReleaseMode) -> str:
parts = version.split(".")
if mode == "major":
next_parts = [int(parts[0]) + 1, 0, 0]
elif mode == "minor":
next_parts = [int(parts[0]), int(parts[1]) + 1, 0]
elif mode == "patch":
next_parts = [int(parts[0]), int(parts[1]), int(parts[2]) + 1]
else:
raise ReleaseActionsError(f"Unexpected mode '{mode}', expected one of "
f"{'|'.join(_RELEASE_MODES)}")
if any(_ZERO_PAD_PATTERN.match(parts[part]) for part in (1, 2)):
return f"{next_parts[0]}.{next_parts[1]:02}.{next_parts[2]:02}"
else:
return f"{next_parts[0]}.{next_parts[1]}.{next_parts[2]}"
def _is_valid_release_branch(branch_name: str) -> bool:
return bool(_RELEASE_BRANCH_PATTERN.match(branch_name))
def _get_base_branch() -> str:
# HEAD points to the commit that updated the VERSION file a moment ago.
# HEAD~1 (previous commit) must be used to determine the base branch.
remote_base_branches = _git(
"branch", '--remote',
"--contains", "HEAD",
'--format=%(refname:short)'
).split("\n")
base_branches = [branch.removeprefix("origin/") for branch in remote_base_branches]
release_branches = set(
branch
for branch in base_branches
if _is_valid_release_branch(branch)
)
assert len(release_branches) == 1, \
("No release branch found that points to HEAD. "
f"Branches pointing to HEAD: {', '.join(base_branches)}")
for branch in base_branches:
if branch == _MASTER_BRANCH or branch.startswith("v"):
return branch
else:
raise ReleaseActionsError(f"Could not find base branch ('master' or 'v*') in "
f"possible branches: {', '.join(base_branches)}")
class ReleaseEvent(NamedTuple):
deploy_mode: Literal["development", "release"]
stage: Literal["branch-created", "pr-merged", "tag-created", "commit-pushed"]
sub_project_id: str | None
version: str
def print_release_context(args: Namespace) -> None:
release_branch_pattern = "release-(?P<mode>[a-z]+)(-(?P<id>\d{4}))?"
release_ref_pattern = rf"^refs/heads/{release_branch_pattern}$"
version_tag_pattern = "refs/tags/v((?P<id>\d{4})-)?(\d{1,2}.\d{1,2}.\d{1,2})"
def _get_project_name(spid: str | None) -> str:
if not spid:
return args.repository_name
try:
return next(Path().glob(f"{spid}_*")).name
except StopIteration:
raise ReleaseActionsError(f"'{spid}' is not a valid project id in this repository!")
def _get_version_file(spid: str | None) -> Path:
if spid:
return Path(f"{_get_project_name(spid)}/VERSION")
return Path("VERSION")
def _get_current_version(spid: str | None, *, required: bool = True) -> str:
versionfile = _get_version_file(spid)
if not versionfile.exists():
if required:
raise ReleaseActionsError(f"version file `{versionfile}` does not exists!")
return ""
return versionfile.read_text().strip()
# create release branch
if args.event == "create" and (match := re.match(release_ref_pattern, args.ref)):
sub_project_id = match.group("id") or None
version = _increase_version(_get_current_version(sub_project_id), match.group("mode"))
event = ReleaseEvent(
deploy_mode="development",
stage="branch-created",
sub_project_id=sub_project_id,
version=version,
)
# merge release PR
elif args.event == "pull_request" and (match := re.match(rf"^{release_branch_pattern}$", args.ref)):
sub_project_id = match.group("id") or None
version = _get_current_version(sub_project_id)
event = ReleaseEvent(
deploy_mode="development",
stage="pr-merged",
sub_project_id=sub_project_id,
version=version,
)
# push version tag
elif args.event == "push" and (match:= re.match(rf"^{version_tag_pattern}$", args.ref)):
sub_project_id = match.group("id") or None
version = _get_current_version(sub_project_id)
event = ReleaseEvent(
deploy_mode="release",
stage="tag-created",
sub_project_id=sub_project_id,
version=version,
)
# commit during development
else:
match = re.match(release_ref_pattern, args.ref)
spid = (match.group("id") or None) if match else None
event = ReleaseEvent(
deploy_mode="development",
stage="commit-pushed",
sub_project_id=spid,
version=_get_current_version(spid=spid, required=match is not None),
)
if event.version:
version_tuple = tuple(map(int, event.version.split(".")))
if version_tuple[1:] == (0, 0):
release_mode: ReleaseMode | None = "major"
elif version_tuple[-1] == 0:
release_mode = "minor"
else:
release_mode = "patch"
else:
release_mode = None
print(f"release-mode={release_mode or ''}")
print(f"release-stage={event.stage}")
print(f"deploy-mode={event.deploy_mode}")
print(f"project-name={_get_project_name(event.sub_project_id)}")
print(f"sub-project-id={event.sub_project_id or ''}")
print(f"version={event.version}")
print(f"version-file={_get_version_file(event.sub_project_id)}")
tag = f"v{event.sub_project_id}-{event.version}" if event.sub_project_id else f"v{event.version}"
print(f"tag={tag}")
if event.stage == "branch-created":
base_branch = _get_base_branch()
major_minor_version = event.version.rsplit(".", 1)[0]
if release_mode == "patch" and event.sub_project_id:
expected_base_branch = f"v{event.sub_project_id}-{major_minor_version}"
elif release_mode == "patch":
expected_base_branch = f"v{major_minor_version}"
else:
expected_base_branch = "master"
if base_branch != expected_base_branch:
raise ReleaseActionsError(f"expected release from branch `{expected_base_branch}`")
print(f"base-branch={base_branch}")
else:
print("base-branch=")
if args.jira_version_template:
jira_version = Template(args.jira_version_template).substitute(projectid=event.sub_project_id, version=event.version)
else:
jira_version = tag
print(f"jira-version={jira_version}")
def main() -> None:
parser = ArgumentParser("Release Actions")
subparsers = parser.add_subparsers(required=True)
prepare_next_version_parser = subparsers.add_parser("print-release-context")
prepare_next_version_parser.set_defaults(func=print_release_context)
prepare_next_version_parser.add_argument("--event", choices=get_type_args(EventName), required=True)
prepare_next_version_parser.add_argument("--repository-name", type=str, required=True)
prepare_next_version_parser.add_argument("--ref", type=str, required=True)
prepare_next_version_parser.add_argument("--jira-version-template", type=str, required=True)
args = parser.parse_args()
args.func(args)
if __name__ == "__main__":
main()