1 | #!/usr/bin/env python3
|
---|
2 | # Copyright © 2019-2020 Intel Corporation
|
---|
3 |
|
---|
4 | # Permission is hereby granted, free of charge, to any person obtaining a copy
|
---|
5 | # of this software and associated documentation files (the "Software"), to deal
|
---|
6 | # in the Software without restriction, including without limitation the rights
|
---|
7 | # to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
---|
8 | # copies of the Software, and to permit persons to whom the Software is
|
---|
9 | # furnished to do so, subject to the following conditions:
|
---|
10 |
|
---|
11 | # The above copyright notice and this permission notice shall be included in
|
---|
12 | # all copies or substantial portions of the Software.
|
---|
13 |
|
---|
14 | # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
---|
15 | # IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
---|
16 | # FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
---|
17 | # AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
---|
18 | # LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
---|
19 | # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
---|
20 | # SOFTWARE.
|
---|
21 |
|
---|
22 | """Update the main page, release notes, and calendar."""
|
---|
23 |
|
---|
24 | import argparse
|
---|
25 | import csv
|
---|
26 | import pathlib
|
---|
27 | import subprocess
|
---|
28 |
|
---|
29 |
|
---|
30 | def update_release_notes(version: str) -> None:
|
---|
31 | p = pathlib.Path('docs') / 'relnotes.rst'
|
---|
32 |
|
---|
33 | with open(p, 'r') as f:
|
---|
34 | relnotes = f.readlines()
|
---|
35 |
|
---|
36 | new_relnotes = []
|
---|
37 | first_list = True
|
---|
38 | second_list = True
|
---|
39 | for line in relnotes:
|
---|
40 | if first_list and line.startswith('-'):
|
---|
41 | first_list = False
|
---|
42 | new_relnotes.append(f'- :doc:`{version} release notes <relnotes/{version}>`\n')
|
---|
43 | if not first_list and second_list and line.startswith(' relnotes/'):
|
---|
44 | second_list = False
|
---|
45 | new_relnotes.append(f' relnotes/{version}\n')
|
---|
46 | new_relnotes.append(line)
|
---|
47 |
|
---|
48 | with open(p, 'w') as f:
|
---|
49 | for line in new_relnotes:
|
---|
50 | f.write(line)
|
---|
51 |
|
---|
52 | subprocess.run(['git', 'add', p])
|
---|
53 |
|
---|
54 |
|
---|
55 | def update_calendar(version: str) -> None:
|
---|
56 | p = pathlib.Path('docs') / 'release-calendar.csv'
|
---|
57 |
|
---|
58 | with p.open('r') as f:
|
---|
59 | calendar = list(csv.reader(f))
|
---|
60 |
|
---|
61 | branch = None
|
---|
62 | for i, line in enumerate(calendar):
|
---|
63 | if line[2] == version:
|
---|
64 | if line[0]:
|
---|
65 | branch = line[0]
|
---|
66 | break
|
---|
67 | if branch is not None:
|
---|
68 | calendar[i + 1][0] = branch
|
---|
69 | del calendar[i]
|
---|
70 |
|
---|
71 | with p.open('w') as f:
|
---|
72 | writer = csv.writer(f)
|
---|
73 | writer.writerows(calendar)
|
---|
74 |
|
---|
75 | subprocess.run(['git', 'add', p])
|
---|
76 |
|
---|
77 |
|
---|
78 | def main() -> None:
|
---|
79 | parser = argparse.ArgumentParser()
|
---|
80 | parser.add_argument('version', help="The released version.")
|
---|
81 | args = parser.parse_args()
|
---|
82 |
|
---|
83 | update_calendar(args.version)
|
---|
84 | done = 'update calendar'
|
---|
85 |
|
---|
86 | if 'rc' not in args.version:
|
---|
87 | update_release_notes(args.version)
|
---|
88 | done += ' and link releases notes'
|
---|
89 |
|
---|
90 | subprocess.run(['git', 'commit', '-m',
|
---|
91 | f'docs: {done} for {args.version}'])
|
---|
92 |
|
---|
93 |
|
---|
94 | if __name__ == "__main__":
|
---|
95 | main()
|
---|