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
|
#!/usr/bin/env python3
# Copyright © 2019-2020 Intel Corporation
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
"""Update the main page, release notes, and calendar."""
import argparse
import pathlib
import subprocess
def update_homepage(version: str) -> None:
p = pathlib.Path(__file__).parent.parent / 'docs' / 'conf.py'
# Don't post release candidates to the homepage
if 'rc' in version:
return
with open(p, 'r') as f:
conf = f.readlines()
new_conf = []
for line in conf:
if line.startswith("version = '") and line.endswith("'\n"):
old_version = line.split("'")[1]
# Avoid overwriting 20.1.0 when releasing 20.0.8
# TODO: we might need more than that to handle 20.0.10
if old_version < version:
line = f"version = '{version}'\n"
new_conf.append(line)
with open(p, 'w') as f:
for line in new_conf:
f.write(line)
subprocess.run(['git', 'add', p])
def update_release_notes(version: str) -> None:
p = pathlib.Path(__file__).parent.parent / 'docs' / 'relnotes.rst'
with open(p, 'r') as f:
relnotes = f.readlines()
new_relnotes = []
first_list = True
for line in relnotes:
if first_list and line.startswith('-'):
first_list = False
new_relnotes.append(f'- `{version} release notes <relnotes/{version}.rst>`__\n')
new_relnotes.append(line)
with open(p, 'w') as f:
for line in new_relnotes:
f.write(line)
subprocess.run(['git', 'add', p])
def update_calendar(version: str) -> None:
p = pathlib.Path(__file__).parent.parent / 'docs' / 'release-calendar.rst'
with open(p, 'r') as f:
calendar = f.readlines()
branch = ''
skip_line = False
new_calendar = []
for line in calendar:
if version in line:
branch = line.split('|')[1].strip()
skip_line = True
elif skip_line:
skip_line = False
elif branch:
# Put the branch number back on the next line
new_calendar.append(line[:2] + branch + line[len(branch) + 2:])
branch = ''
else:
new_calendar.append(line)
with open(p, 'w') as f:
for line in new_calendar:
f.write(line)
subprocess.run(['git', 'add', p])
def main() -> None:
parser = argparse.ArgumentParser()
parser.add_argument('version', help="The released version.")
args = parser.parse_args()
update_homepage(args.version)
update_calendar(args.version)
done = 'update calendar'
if not is_release_candidate(args.version):
update_index(args.version)
update_release_notes(args.version)
done += ', add news item, and link releases notes'
subprocess.run(['git', 'commit', '-m',
f'docs: {done} for {args.version}'])
if __name__ == "__main__":
main()
|
