-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
/
make_release.py
350 lines (259 loc) · 8.57 KB
/
make_release.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
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
#!/usr/bin/env python3 -u
# copyright: sktime developers, BSD-3-Clause License (see LICENSE file)
"""Do-nothing script for making a release.
This idea comes from here:
- https://blog.danslimmon.com/2019/07/15/do-nothing-scripting-the-key-to
-gradual-automation/
The script is adapted from:
- https://github.com/alan-turing-institute/CleverCSV/blob/master
/make_release.py
"""
__author__ = ["mloning"]
import codecs
import os
import re
import webbrowser
import colorama
ROOT_DIR = os.path.abspath(os.path.dirname(__file__)).replace("build_tools", "")
PACKAGE_NAME = "sktime"
class URLs:
"""Container class for URLs."""
DOCS_LOCAL = "file://" + os.path.realpath(
os.path.join(ROOT_DIR, "docs/_build/html/index.html")
)
DOCS_ONLINE = "https://www.sktime.net"
PYPI = f"https://pypi.org/simple/{PACKAGE_NAME}/"
def read(*parts):
"""Read from parts."""
# intentionally *not* adding an encoding option to open, See:
# https://github.com/pypa/virtualenv/issues/201#issuecomment-3145690
with codecs.open(os.path.join(ROOT_DIR, *parts), "r") as fp:
return fp.read()
def find_version(*file_paths):
"""Find version string."""
version_file = read(*file_paths)
version_match = re.search(r"^__version__ = ['\"]([^'\"]*)['\"]", version_file, re.M)
if version_match:
return version_match.group(1)
else:
raise RuntimeError("Unable to find version string.")
def open_website(website):
"""Open website."""
webbrowser.open(website, new=1)
def colored(msg, color=None, style=None):
"""Print message with colors."""
colors = {
"red": colorama.Fore.RED,
"green": colorama.Fore.GREEN,
"cyan": colorama.Fore.CYAN,
"yellow": colorama.Fore.YELLOW,
"magenta": colorama.Fore.MAGENTA,
None: "",
}
styles = {
"bright": colorama.Style.BRIGHT,
"dim": colorama.Style.DIM,
None: "",
}
pre = colors[color] + styles[style]
post = colorama.Style.RESET_ALL
return f"{pre}{msg}{post}"
def cprint(msg, color=None, style=None):
"""Coloured printing."""
print(colored(msg, color=color, style=style))
def wait_for_enter():
"""Wait for Enter."""
input(colored("\nPress Enter to continue", style="dim"))
print()
class Step:
"""Abstraction for release step."""
def pre(self, context):
"""Pre-step."""
def post(self, context):
"""Post-step."""
wait_for_enter()
def run(self, context):
"""Run step."""
try:
self.pre(context)
self.action(context)
self.post(context)
except KeyboardInterrupt:
cprint("\nInterrupted.", color="red")
raise SystemExit(1)
@staticmethod
def instruct(msg):
"""Instruction."""
cprint(msg, color="green")
def print_run(self, msg):
"""Print run step."""
cprint("Run:", color="cyan", style="bright")
self.print_cmd(msg)
@staticmethod
def print_cmd(msg):
"""Print cmd step."""
cprint("\t" + msg, color="cyan", style="bright")
@staticmethod
def do_cmd(cmd):
"""Wait for confirmation."""
cprint(f"Going to run: {cmd}", color="magenta", style="bright")
wait_for_enter()
os.system(cmd)
def action(self, context):
"""Carry out action."""
raise NotImplementedError("abstract method")
class ConfirmGitStatus(Step):
"""Confirm git status."""
def __init__(self, branch):
self.branch = branch
def action(self, context):
"""Carry out action."""
self.instruct(
f"Make sure you're on: {self.branch}, you're local "
f"branch is up-to-date, and all new changes are merged "
f"in."
)
self.do_cmd(f"git checkout {self.branch}")
self.do_cmd("git pull")
class UpdateChangelog(Step):
"""Update the changelog."""
def action(self, context):
"""Carry out action."""
self.instruct(f"Update CHANGELOG for version: {context['version']}")
class UpdateReadme(Step):
"""Update the readme."""
def action(self, context):
"""Carry out action."""
self.instruct(f"Update README for version: {context['version']}")
class UpdateVersion(Step):
"""Update sktime version."""
def action(self, context):
"""Carry out action."""
self.instruct("Update __init__.py with new version")
def post(self, context):
"""Post-action step."""
wait_for_enter()
context["version"] = find_version(context["package_name"], "__init__.py")
class MakeClean(Step):
"""Make clean."""
def action(self, context):
"""Carry out action."""
self.do_cmd("make clean")
class MakeDocs(Step):
"""Make docs."""
def action(self, context):
"""Carry out action."""
self.do_cmd("make docs")
class MakeDist(Step):
"""Make dist."""
def action(self, context):
"""Carry out action."""
self.do_cmd("make dist")
class UploadToTestPyPI(Step):
"""Upload to test pypi."""
def action(self, context):
"""Carry out action."""
self.instruct("Upload to TestPyPI")
cmd = "twine upload --repository-url https://test.pypi.org/legacy/ dist/*"
self.do_cmd(cmd)
class InstallFromTestPyPI(Step):
"""Install from test pypi."""
def action(self, context):
"""Carry out action."""
self.instruct("Check installation from TestPyPI")
self.do_cmd(
f"sh build_tools/check_install_from_test_pypi.sh {context['version']}"
)
class CheckVersionNumber(Step):
"""Check version number."""
def action(self, context):
"""Carry out action."""
self.instruct(
f"Ensure that the following command gives version: {context['version']}"
)
self.do_cmd(
f"python -c 'import {context['package_name']}; print("
f"{context['package_name']}.__version__)'"
)
class GitTagRelease(Step):
"""Git tag release."""
def action(self, context):
"""Carry out action."""
self.instruct("Tag version as a release")
self.do_cmd(f"git tag v{context['version']}")
class GitTagPreRelease(Step):
"""Git tag prerelease."""
def action(self, context):
"""Carry out action."""
self.instruct("Tag version as a pre-release (increment as needed)")
self.print_run(f"git tag v{context['version']}-rc.1")
class PushToGitHub(Step):
"""Push to GitHub."""
def action(self, context):
"""Carry out action."""
self.instruct("Add and commit to git, then push to GitHub")
class CheckCIStatus(Step):
"""Check CI status."""
def action(self, context):
"""Carry out action."""
self.instruct("Wait for CI to complete and check status")
class CheckOnlineDocs(Step):
"""Check online docs."""
def action(self, context):
"""Carry out action."""
self.instruct("Check online docs")
open_website(URLs.DOCS_ONLINE)
class CheckLocalDocs(Step):
"""Check local docs."""
def action(self, context):
"""Carry out action."""
self.instruct("Check local docs")
open_website(URLs.DOCS_LOCAL)
class CheckPyPIFiles(Step):
"""Check pypi files."""
def action(self, context):
"""Carry out action."""
self.instruct("Check PyPI files")
open_website(URLs.PYPI)
class PushTagToGitHub(Step):
"""Push tag to GitHub."""
def action(self, context):
"""Carry out action."""
self.do_cmd(f"git push origin v{context['version']}")
def main():
"""Run release, main script."""
colorama.init()
steps = [
# prepare and run final checks
ConfirmGitStatus(branch="main"),
MakeClean(),
UpdateVersion(),
CheckVersionNumber(),
UpdateReadme(),
UpdateChangelog(),
MakeDocs(),
CheckLocalDocs(),
MakeDist(),
UploadToTestPyPI(),
InstallFromTestPyPI(),
PushToGitHub(),
CheckCIStatus(),
# check pre-release online
# GitTagPreRelease(),
# PushTagToGitHub(),
# make release
GitTagRelease(),
PushTagToGitHub(),
CheckCIStatus(),
CheckOnlineDocs(),
CheckPyPIFiles(),
]
context = dict()
context["package_name"] = PACKAGE_NAME
context["version"] = find_version(context["package_name"], "__init__.py")
context["testdir"] = "temp/"
for step in steps:
step.run(context)
cprint("\nDone!", color="yellow", style="bright")
if __name__ == "__main__":
main()