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 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381
|
"""Internal tool to update the CHANGELOG."""
import json
import subprocess
import urllib.request
from dataclasses import dataclass
from datetime import datetime, timezone
from typing import Dict, List, Tuple
GH_ORG = "py-pdf"
GH_PROJECT = "pypdf"
VERSION_FILE_PATH = "pypdf/_version.py"
CHANGELOG_FILE_PATH = "CHANGELOG.md"
@dataclass(frozen=True)
class Change:
"""Capture the data of a git commit."""
commit_hash: str
prefix: str
message: str
author: str
author_login: str
def main(changelog_path: str) -> None:
"""
Create a changelog.
Args:
changelog_path: The location of the CHANGELOG file
"""
changelog = get_changelog(changelog_path)
git_tag = get_most_recent_git_tag()
changes, changes_with_author = get_formatted_changes(git_tag)
if changes == "":
print("No changes")
return
new_version = version_bump(git_tag)
new_version = get_version_interactive(new_version, changes)
adjust_version_py(new_version)
today = datetime.now(tz=timezone.utc)
header = f"## Version {new_version}, {today:%Y-%m-%d}\n"
url = f"https://github.com/{GH_ORG}/{GH_PROJECT}/compare/{git_tag}...{new_version}"
trailer = f"\n[Full Changelog]({url})\n\n"
new_entry = header + changes + trailer
print(new_entry)
write_commit_msg_file(new_version, changes_with_author + trailer)
# write_release_msg_file(new_version, changes_with_author + trailer, today)
# Make the script idempotent by checking if the new entry is already in the changelog
if new_entry in changelog:
print("Changelog is already up-to-date!")
return
new_changelog = "# CHANGELOG\n\n" + new_entry + strip_header(changelog)
write_changelog(new_changelog, changelog_path)
print_instructions(new_version)
def print_instructions(new_version: str) -> None:
"""Print release instructions."""
print("=" * 80)
print(f"☑ {VERSION_FILE_PATH} was adjusted to '{new_version}'")
print(f"☑ {CHANGELOG_FILE_PATH} was adjusted")
print()
print("Now run:")
print(" git commit -eF RELEASE_COMMIT_MSG.md")
print(" git push")
def adjust_version_py(version: str) -> None:
"""Adjust the __version__ string."""
with open(VERSION_FILE_PATH, "w") as fp:
fp.write(f'__version__ = "{version}"\n')
def get_version_interactive(new_version: str, changes: str) -> str:
"""Get the new __version__ interactively."""
from rich.prompt import Prompt
print("The changes are:")
print(changes)
orig = new_version
new_version = Prompt.ask("New semantic version", default=orig)
while not is_semantic_version(new_version):
new_version = Prompt.ask(
"That was not a semantic version. Please enter a semantic version",
default=orig,
)
return new_version
def is_semantic_version(version: str) -> bool:
"""Check if the given version is a semantic version."""
# This doesn't cover the edge-cases like pre-releases
if version.count(".") != 2:
return False
try:
return bool([int(part) for part in version.split(".")])
except Exception:
return False
def write_commit_msg_file(new_version: str, commit_changes: str) -> None:
"""
Write a file that can be used as a commit message.
Like this:
git commit -eF RELEASE_COMMIT_MSG.md && git push
"""
with open("RELEASE_COMMIT_MSG.md", "w") as fp:
fp.write(f"REL: {new_version}\n\n")
fp.write("## What's new\n")
fp.write(commit_changes)
def write_release_msg_file(
new_version: str, commit_changes: str, today: datetime
) -> None:
"""
Write a file that can be used as a git tag message.
Like this:
git tag -eF RELEASE_TAG_MSG.md && git push
"""
with open("RELEASE_TAG_MSG.md", "w") as fp:
fp.write(f"Version {new_version}, {today:%Y-%m-%d}\n\n")
fp.write("## What's new\n")
fp.write(commit_changes)
def strip_header(md: str) -> str:
"""Remove the 'CHANGELOG' header."""
return md.removeprefix("# CHANGELOG").lstrip()
def version_bump(git_tag: str) -> str:
"""
Increase the patch version of the git tag by one.
Args:
git_tag: Old version tag
Returns:
The new version where the patch version is bumped.
"""
# just assume a patch version change
major, minor, patch = git_tag.split(".")
return f"{major}.{minor}.{int(patch) + 1}"
def get_changelog(changelog_path: str) -> str:
"""
Read the changelog.
Args:
changelog_path: Path to the CHANGELOG file
Returns:
Data of the CHANGELOG
"""
with open(changelog_path, encoding="utf-8") as fh:
return fh.read()
def write_changelog(new_changelog: str, changelog_path: str) -> None:
"""
Write the changelog.
Args:
new_changelog: Contents of the new CHANGELOG
changelog_path: Path where the CHANGELOG file is
"""
with open(changelog_path, "w", encoding="utf-8") as fh:
fh.write(new_changelog)
def get_formatted_changes(git_tag: str) -> Tuple[str, str]:
"""
Format the changes done since the last tag.
Args:
git_tag: the reference tag
Returns:
Changes done since git_tag
"""
commits = get_git_commits_since_tag(git_tag)
# Group by prefix
grouped = {}
for commit in commits:
if commit.prefix not in grouped:
grouped[commit.prefix] = []
grouped[commit.prefix].append(
{"msg": commit.message, "author": commit.author_login}
)
# Order prefixes
order = [
"SEC",
"DEP",
"ENH",
"PI",
"BUG",
"ROB",
"DOC",
"DEV",
"CI",
"MAINT",
"TST",
"STY",
]
abbrev2long = {
"SEC": "Security",
"DEP": "Deprecations",
"ENH": "New Features",
"BUG": "Bug Fixes",
"ROB": "Robustness",
"DOC": "Documentation",
"DEV": "Developer Experience",
"CI": "Continuous Integration",
"MAINT": "Maintenance",
"TST": "Testing",
"STY": "Code Style",
"PI": "Performance Improvements",
}
# Create output
output = ""
output_with_user = ""
for prefix in order:
if prefix not in grouped:
continue
tmp = f"\n### {abbrev2long[prefix]} ({prefix})\n" # header
output += tmp
output_with_user += tmp
for commit in grouped[prefix]:
output += f"- {commit['msg']}\n"
output_with_user += f"- {commit['msg']} by @{commit['author']}\n"
del grouped[prefix]
if grouped:
output += "\n### Other\n"
output_with_user += "\n### Other\n"
for prefix, commits in grouped.items():
for commit in commits:
output += f"- {prefix}: {commit['msg']}\n"
output_with_user += (
f"- {prefix}: {commit['msg']} by @{commit['author']}\n"
)
return output, output_with_user
def get_most_recent_git_tag() -> str:
"""
Get the git tag most recently created.
Returns:
Most recently created git tag.
"""
return subprocess.check_output(
["git", "describe", "--tag", "--abbrev=0"], stderr=subprocess.STDOUT, text=True
).strip()
def get_author_mapping(line_count: int) -> Dict[str, str]:
"""
Get the authors for each commit.
Args:
line_count: Number of lines from Git log output. Used for determining how
many commits to fetch.
Returns:
A mapping of long commit hashes to author login handles.
"""
per_page = min(line_count, 100)
page = 1
mapping: Dict[str, str] = {}
for _ in range(0, line_count, per_page):
with urllib.request.urlopen(
f"https://api.github.com/repos/{GH_ORG}/{GH_PROJECT}/commits?per_page={per_page}&page={page}"
) as response:
commits = json.loads(response.read())
page += 1
for commit in commits:
mapping[commit["sha"]] = commit["author"]["login"]
return mapping
def get_git_commits_since_tag(git_tag: str) -> List[Change]:
"""
Get all commits since the last tag.
Args:
git_tag: Reference tag from which the changes to the current commit are
fetched.
Returns:
List of all changes since git_tag.
"""
commits = (
subprocess.check_output(
[
"git",
"--no-pager",
"log",
f"{git_tag}..HEAD",
'--pretty=format:"%H:::%s:::%aN"',
],
stderr=subprocess.STDOUT,
)
.decode("UTF-8")
.strip()
)
lines = commits.splitlines()
authors = get_author_mapping(len(lines))
return [parse_commit_line(line, authors) for line in lines if line != ""]
def parse_commit_line(line: str, authors: Dict[str, str]) -> Change:
"""
Parse the first line of a git commit message.
Args:
line: The first line of a git commit message.
Returns:
The parsed Change object
Raises:
ValueError: The commit line is not well-structured
"""
parts = line.strip().strip('"\\').split(":::")
if len(parts) != 3:
raise ValueError(f"Invalid commit line: '{line}'")
commit_hash, rest, author = parts
if ":" in rest:
prefix, message = rest.split(": ", 1)
else:
prefix = ""
message = rest
# Standardize
message = message.strip()
commit_hash = commit_hash.strip()
author_login = authors[commit_hash]
prefix = prefix.strip()
if prefix == "DOCS":
prefix = "DOC"
return Change(
commit_hash=commit_hash,
prefix=prefix,
message=message,
author=author,
author_login=author_login,
)
if __name__ == "__main__":
main(CHANGELOG_FILE_PATH)
|