|
| 1 | +"""Prepare a release by updating the package version and release notes.""" |
| 2 | + |
| 3 | +import re |
| 4 | +from datetime import date |
| 5 | +from pathlib import Path |
| 6 | +from typing import Annotated, Literal |
| 7 | + |
| 8 | +import typer |
| 9 | + |
| 10 | +VERSION_PATTERN = re.compile(r'(?m)^__version__ = "(\d+\.\d+\.\d+)"$') |
| 11 | +VERSION_HEADING_PATTERN = re.compile(r"(?m)^## (\d+\.\d+\.\d+)(?: \([^)]+\))?$") |
| 12 | +RELEASE_NOTES_HEADER = "# Release Notes\n\n" |
| 13 | +LATEST_CHANGES_HEADER = "## Latest Changes" |
| 14 | +BumpType = Literal["major", "minor", "patch"] |
| 15 | + |
| 16 | +app = typer.Typer() |
| 17 | + |
| 18 | + |
| 19 | +def parse_version(version: str) -> tuple[int, int, int]: |
| 20 | + match = re.fullmatch(r"\d+\.\d+\.\d+", version) |
| 21 | + if not match: |
| 22 | + raise ValueError(f"Invalid version: {version!r}. Expected format: X.Y.Z") |
| 23 | + major, minor, patch = version.split(".") |
| 24 | + return int(major), int(minor), int(patch) |
| 25 | + |
| 26 | + |
| 27 | +def get_current_version(content: str, version_file: Path) -> str: |
| 28 | + matches = list(VERSION_PATTERN.finditer(content)) |
| 29 | + if len(matches) != 1: |
| 30 | + raise RuntimeError( |
| 31 | + f"Expected exactly one __version__ assignment in {version_file}, " |
| 32 | + f"found {len(matches)}" |
| 33 | + ) |
| 34 | + return matches[0].group(1) |
| 35 | + |
| 36 | + |
| 37 | +def bump_version(version: str, bump: BumpType) -> str: |
| 38 | + major, minor, patch = parse_version(version) |
| 39 | + if bump == "major": |
| 40 | + return f"{major + 1}.0.0" |
| 41 | + if bump == "minor": |
| 42 | + return f"{major}.{minor + 1}.0" |
| 43 | + return f"{major}.{minor}.{patch + 1}" |
| 44 | + |
| 45 | + |
| 46 | +def update_version_file(content: str, version: str, version_file: Path) -> str: |
| 47 | + current_version = get_current_version(content, version_file) |
| 48 | + if parse_version(version) <= parse_version(current_version): |
| 49 | + raise RuntimeError( |
| 50 | + f"New version {version} must be greater than current version {current_version}" |
| 51 | + ) |
| 52 | + return VERSION_PATTERN.sub(f'__version__ = "{version}"', content, count=1) |
| 53 | + |
| 54 | + |
| 55 | +def update_release_notes( |
| 56 | + content: str, version: str, release_date: date, release_notes_file: Path |
| 57 | +) -> str: |
| 58 | + if not content.startswith(RELEASE_NOTES_HEADER): |
| 59 | + raise RuntimeError( |
| 60 | + f"{release_notes_file} must start with {RELEASE_NOTES_HEADER!r}" |
| 61 | + ) |
| 62 | + if re.search(rf"^## {re.escape(version)}(?: \([^)]+\))?$", content, re.M): |
| 63 | + raise RuntimeError(f"Release notes already contain a section for {version}") |
| 64 | + |
| 65 | + latest_header = f"{RELEASE_NOTES_HEADER}{LATEST_CHANGES_HEADER}\n" |
| 66 | + if not content.startswith(latest_header): |
| 67 | + raise RuntimeError(f"{release_notes_file} must start with {latest_header!r}") |
| 68 | + |
| 69 | + release_header = f"## {version} ({release_date.isoformat()})" |
| 70 | + return content.replace( |
| 71 | + latest_header, |
| 72 | + f"{RELEASE_NOTES_HEADER}{LATEST_CHANGES_HEADER}\n\n{release_header}\n", |
| 73 | + 1, |
| 74 | + ) |
| 75 | + |
| 76 | + |
| 77 | +def get_release_notes_body(content: str, version: str, release_notes_file: Path) -> str: |
| 78 | + version_heading = re.compile(rf"(?m)^## {re.escape(version)}(?: \([^)]+\))?$") |
| 79 | + match = version_heading.search(content) |
| 80 | + if not match: |
| 81 | + raise RuntimeError( |
| 82 | + f"Could not find release notes section for {version} in {release_notes_file}" |
| 83 | + ) |
| 84 | + |
| 85 | + next_match = VERSION_HEADING_PATTERN.search(content, match.end()) |
| 86 | + end = next_match.start() if next_match else len(content) |
| 87 | + body = content[match.end() : end].strip() |
| 88 | + if not body: |
| 89 | + raise RuntimeError( |
| 90 | + f"Release notes section for {version} in {release_notes_file} is empty" |
| 91 | + ) |
| 92 | + return f"{body}\n" |
| 93 | + |
| 94 | + |
| 95 | +@app.command() |
| 96 | +def prepare( |
| 97 | + bump: Annotated[ |
| 98 | + BumpType, |
| 99 | + typer.Argument( |
| 100 | + envvar="PREPARE_RELEASE_BUMP", |
| 101 | + help="The release bump to make: major, minor, or patch.", |
| 102 | + ), |
| 103 | + ], |
| 104 | + version_file: Annotated[ |
| 105 | + Path, |
| 106 | + typer.Option( |
| 107 | + envvar="PREPARE_RELEASE_VERSION_FILE", |
| 108 | + exists=True, |
| 109 | + file_okay=True, |
| 110 | + dir_okay=False, |
| 111 | + readable=True, |
| 112 | + writable=True, |
| 113 | + help="Path to the Python file containing the __version__ assignment.", |
| 114 | + ), |
| 115 | + ], |
| 116 | + release_notes_file: Annotated[ |
| 117 | + Path, |
| 118 | + typer.Option( |
| 119 | + envvar="PREPARE_RELEASE_RELEASE_NOTES_FILE", |
| 120 | + exists=True, |
| 121 | + file_okay=True, |
| 122 | + dir_okay=False, |
| 123 | + readable=True, |
| 124 | + writable=True, |
| 125 | + help="Path to the release notes Markdown file.", |
| 126 | + ), |
| 127 | + ], |
| 128 | + release_date: Annotated[ |
| 129 | + str, |
| 130 | + typer.Option( |
| 131 | + "--date", |
| 132 | + envvar="PREPARE_RELEASE_DATE", |
| 133 | + help="Release date in YYYY-MM-DD format. Defaults to today.", |
| 134 | + ), |
| 135 | + ] = date.today().isoformat(), |
| 136 | +) -> None: |
| 137 | + parsed_release_date = date.fromisoformat(release_date or date.today().isoformat()) |
| 138 | + |
| 139 | + version_file_content = version_file.read_text() |
| 140 | + release_notes_content = release_notes_file.read_text() |
| 141 | + version = bump_version( |
| 142 | + get_current_version(version_file_content, version_file), bump |
| 143 | + ) |
| 144 | + |
| 145 | + version_file.write_text( |
| 146 | + update_version_file(version_file_content, version, version_file) |
| 147 | + ) |
| 148 | + release_notes_file.write_text( |
| 149 | + update_release_notes( |
| 150 | + release_notes_content, version, parsed_release_date, release_notes_file |
| 151 | + ) |
| 152 | + ) |
| 153 | + |
| 154 | + typer.echo(f"Prepared release {version} ({parsed_release_date.isoformat()})") |
| 155 | + |
| 156 | + |
| 157 | +@app.command() |
| 158 | +def current_version( |
| 159 | + version_file: Annotated[ |
| 160 | + Path, |
| 161 | + typer.Option( |
| 162 | + envvar="PREPARE_RELEASE_VERSION_FILE", |
| 163 | + exists=True, |
| 164 | + file_okay=True, |
| 165 | + dir_okay=False, |
| 166 | + readable=True, |
| 167 | + help="Path to the Python file containing the __version__ assignment.", |
| 168 | + ), |
| 169 | + ], |
| 170 | +) -> None: |
| 171 | + typer.echo(get_current_version(version_file.read_text(), version_file)) |
| 172 | + |
| 173 | + |
| 174 | +@app.command() |
| 175 | +def release_notes( |
| 176 | + version_file: Annotated[ |
| 177 | + Path, |
| 178 | + typer.Option( |
| 179 | + envvar="PREPARE_RELEASE_VERSION_FILE", |
| 180 | + exists=True, |
| 181 | + file_okay=True, |
| 182 | + dir_okay=False, |
| 183 | + readable=True, |
| 184 | + help="Path to the Python file containing the __version__ assignment.", |
| 185 | + ), |
| 186 | + ], |
| 187 | + release_notes_file: Annotated[ |
| 188 | + Path, |
| 189 | + typer.Option( |
| 190 | + envvar="PREPARE_RELEASE_RELEASE_NOTES_FILE", |
| 191 | + exists=True, |
| 192 | + file_okay=True, |
| 193 | + dir_okay=False, |
| 194 | + readable=True, |
| 195 | + help="Path to the release notes Markdown file.", |
| 196 | + ), |
| 197 | + ], |
| 198 | +) -> None: |
| 199 | + version = get_current_version(version_file.read_text(), version_file) |
| 200 | + typer.echo( |
| 201 | + get_release_notes_body( |
| 202 | + release_notes_file.read_text(), version, release_notes_file |
| 203 | + ), |
| 204 | + nl=False, |
| 205 | + ) |
| 206 | + |
| 207 | + |
| 208 | +if __name__ == "__main__": |
| 209 | + app() |
0 commit comments