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
|
#!/usr/bin/env python3
from __future__ import annotations
import argparse
import datetime
import json
import os
import re
import subprocess
import sys
from pathlib import Path
from typing import Tuple
parser = argparse.ArgumentParser(description="Tags and releases the next version of this project.")
parser.add_argument("tag", help="Semantic version number to use as the tag.")
parser.add_argument("-e", "--edit", action="store_true", help="Force edits of git commits.")
parser.add_argument("-n", "--dry-run", action="store_true", help="Don't modify files.")
parser.add_argument("-v", "--verbose", action="store_true", help="Print debug information.")
PROJECT_DIR = Path(__file__).parent.parent # Project directory relative to this script.
CHANGELOG_PATH = PROJECT_DIR / "CHANGELOG.md"
def parse_changelog(args: argparse.Namespace) -> Tuple[str, str]:
"""Return an updated changelog and and the list of changes."""
match = re.match(
pattern=r"(.*?## \[Unreleased]\n)(.+?\n)(\n*## \[.*)",
string=CHANGELOG_PATH.read_text(encoding="utf-8"),
flags=re.DOTALL,
)
assert match
header, changes, tail = match.groups()
tagged = "\n## [%s] - %s\n%s" % (
args.tag,
datetime.date.today().isoformat(),
changes,
)
if args.verbose:
print(tagged)
return "".join((header, tagged, tail)), changes
VERSION_SOURCE = """\
{head}
#define TCOD_MAJOR_VERSION {major}
#define TCOD_MINOR_VERSION {minor}
#define TCOD_PATCHLEVEL {patch}
#define TCOD_STRVERSION "{tag}"
{tail}"""
def update_version_header(args: argparse.Namespace) -> None:
"""Update version.h to use the given tag."""
VERSION_HEADER = Path("src/libtcod/version.h")
match = re.match(
pattern=r"(?P<head>.*?)\n#define TCOD_MAJOR_VERSION.*?TCOD_STRVERSION[^\n]*\n(?P<tail>.*)",
string=VERSION_HEADER.read_text(encoding="utf-8"),
flags=re.DOTALL,
)
assert match
format_args = {"tag": args.tag}
format_args.update(match.groupdict())
match = re.match(
pattern=r"(?P<major>[0-9]+)\.(?P<minor>[0-9]+)\.(?P<patch>[0-9]+)",
string=args.tag,
)
assert match
format_args.update(match.groupdict())
source = VERSION_SOURCE.format(**format_args)
if not args.dry_run:
VERSION_HEADER.write_text(source, encoding="utf-8")
def update_vcpkg_manifest(args: argparse.Namespace) -> None:
"""Update the version on the vcpkg.json manifest."""
with open("vcpkg.json", "r", encoding="utf-8") as f:
vcpkg_manifest = json.load(f)
vcpkg_manifest["version-semver"] = args.tag
if not args.dry_run:
with open("vcpkg.json", "w", encoding="utf-8") as f:
json.dump(vcpkg_manifest, f, indent=2)
def replace_unreleased_tags(tag: str, dry_run: bool, path: Path) -> None:
"""Replace "unreleased" version tags with the provided tag.
Such as the following examples:
".. versionadded:: unreleased" -> ".. versionadded:: <tag>"
"@versionadded{Unreleased}" -> "@versionadded{<tag>}"
"""
match = re.match(r"\d+\.\d+", tag) # Get "major.minor" version.
assert match
short_tag = match.group()
for directory, _, files in os.walk(path):
for filename in files:
file = Path(directory, filename)
if file.suffix not in {".c", ".cpp", ".h", ".hpp"}:
continue
text = file.read_text(encoding="utf-8")
new_text = re.sub(
r":: *unreleased",
rf":: {short_tag}",
text,
flags=re.IGNORECASE,
)
new_text = re.sub(
r"@versionadded{ *unreleased *}",
rf"@versionadded{{{short_tag}}}",
new_text,
flags=re.IGNORECASE,
)
if text != new_text:
print(f"Update tags in {file}")
if not dry_run:
file.write_text(new_text, encoding="utf-8")
def main() -> None:
if len(sys.argv) == 1:
parser.print_help(sys.stderr)
sys.exit(1)
args = parser.parse_args()
if args.verbose:
print(args)
update_version_header(args)
new_changelog, changes = parse_changelog(args)
update_vcpkg_manifest(args)
replace_unreleased_tags(args.tag, args.dry_run, PROJECT_DIR / "src")
if not args.dry_run:
CHANGELOG_PATH.write_text(new_changelog, encoding="utf-8")
edit = ["-e"] if args.edit else []
subprocess.check_call(
["git", "commit", "-avm", f"Prepare {args.tag} release.", *edit],
)
subprocess.check_call(
["git", "tag", args.tag, "-a", "-m", f"{args.tag}\n\n{changes}", *edit],
)
if __name__ == "__main__":
main()
|
