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
|
"""
This script permits to upgrade the changelog in astroid or pylint when releasing a version.
"""
import argparse
from datetime import datetime
from pathlib import Path
DEFAULT_CHANGELOG_PATH = Path("ChangeLog")
err = "in the changelog, fix that first!"
TBA_ERROR_MSG = "More than one release date 'TBA' %s" % err
NEW_VERSION_ERROR_MSG = "The text for this version '{version}' did not exists %s" % err
NEXT_VERSION_ERROR_MSG = (
"The text for the next version '{version}' already exists %s" % err
)
TODAY = datetime.now()
WHATS_NEW_TEXT = "What's New in astroid"
FULL_WHATS_NEW_TEXT = WHATS_NEW_TEXT + " {version}?"
RELEASE_DATE_TEXT = "Release Date: TBA"
NEW_RELEASE_DATE_MESSAGE = "Release Date: {}".format(TODAY.strftime("%Y-%m-%d"))
def main() -> None:
parser = argparse.ArgumentParser(add_help=__doc__)
parser.add_argument("version", help="The version we want to release")
args = parser.parse_args()
if "dev" not in args.version:
version = args.version
next_version = get_next_version(version)
run(version, next_version)
def get_next_version(version: str) -> str:
new_version = version.split(".")
new_version[2] = str(int(new_version[2]) + 1)
return ".".join(new_version)
def run(version: str, next_version: str) -> None:
with open(DEFAULT_CHANGELOG_PATH) as f:
content = f.read()
content = transform_content(content, version, next_version)
with open(DEFAULT_CHANGELOG_PATH, "w") as f:
f.write(content)
def transform_content(content: str, version: str, next_version: str) -> str:
wn_new_version = FULL_WHATS_NEW_TEXT.format(version=version)
wn_next_version = FULL_WHATS_NEW_TEXT.format(version=next_version)
# There is only one field where the release date is TBA
assert content.count(RELEASE_DATE_TEXT) == 1, TBA_ERROR_MSG
# There is already a release note for the version we want to release
assert content.count(wn_new_version) == 1, NEW_VERSION_ERROR_MSG.format(
version=version
)
# There is no release notes for the next version
assert content.count(wn_next_version) == 0, NEXT_VERSION_ERROR_MSG.format(
version=next_version
)
index = content.find(WHATS_NEW_TEXT)
content = content.replace(RELEASE_DATE_TEXT, NEW_RELEASE_DATE_MESSAGE)
end_content = content[index:]
content = content[:index]
content += wn_next_version + "\n"
content += "=" * len(wn_next_version) + "\n"
content += RELEASE_DATE_TEXT + "\n" * 4
content += end_content
return content
if __name__ == "__main__":
main()
|
