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 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446
|
import asyncio
import contextlib
import datetime
import os
import pathlib
import re
import shutil
import subprocess
import sys
from collections import defaultdict
from collections.abc import Generator
from dataclasses import dataclass
from typing import Optional
import click
import httpx
import msgspec
_polar = "[Polar.sh](https://polar.sh/litestar-org)"
_open_collective = "[OpenCollective](https://opencollective.com/litestar)"
_github_sponsors = "[GitHub Sponsors](https://github.com/sponsors/litestar-org/)"
class PullRequest(msgspec.Struct, kw_only=True):
title: str
number: int
body: str
created_at: str
user: "RepoUser"
merge_commit_sha: Optional[str] = None
class Comp(msgspec.Struct):
sha: str
class _Commit(msgspec.Struct):
message: str
url: str
commit: _Commit
class RepoUser(msgspec.Struct):
login: str
id: int
type: str
@dataclass
class PRInfo:
url: str
title: str
clean_title: str
cc_type: str
number: int
closes: list[int]
created_at: datetime.datetime
description: str
user: RepoUser
@dataclass
class ReleaseInfo:
base: str
release_tag: str
version: str
pull_requests: dict[str, list[PRInfo]]
first_time_prs: list[PRInfo]
@property
def compare_url(self) -> str:
return f"https://github.com/litestar-org/advanced-alchemy/compare/{self.base}...{self.release_tag}"
def _pr_number_from_commit(comp: Comp) -> Optional[int]:
# this is an ugly hack, but it appears to actually be the most reliably way to
# extract the most "reliable" way to extract the info we want from GH ¯\_(ツ)_/¯
message_head = comp.commit.message.split("\n\n")[0]
match = re.search(r"\(#(\d+)\)$", message_head)
if not match:
print(f"Could not find PR number in {message_head}") # noqa: T201
return int(match[1]) if match else None
class _Thing:
def __init__(self, *, gh_token: str, base: str, release_branch: str, tag: str, version: str) -> None:
self._gh_token = gh_token
self._base = base
self._new_release_tag = tag
self._release_branch = release_branch
self._new_release_version = version
self._base_client = httpx.AsyncClient(
headers={
"Authorization": f"Bearer {gh_token}",
}
)
self._api_client = httpx.AsyncClient(
headers={
**self._base_client.headers,
"X-GitHub-Api-Version": "2022-11-28",
"Accept": "application/vnd.github+json",
},
base_url="https://api.github.com/repos/litestar-org/advanced-alchemy/",
)
async def get_closing_issues_references(self, pr_number: int) -> list[int]:
graphql_query = """{
repository(owner: "litestar-org", name: "advanced-alchemy") {
pullRequest(number: %d) {
id
closingIssuesReferences (first: 10) {
edges {
node {
number
}
}
}
}
}
}"""
query = graphql_query % (pr_number,)
res = await self._base_client.post("https://api.github.com/graphql", json={"query": query})
if res.is_client_error:
return []
data = res.json()
return [
edge["node"]["number"]
for edge in data["data"]["repository"]["pullRequest"]["closingIssuesReferences"]["edges"]
]
async def _get_pr_info_for_pr(self, number: int) -> Optional[PRInfo]:
res = await self._api_client.get(f"/pulls/{number}")
if res.is_client_error:
click.secho(
f"Could not get PR info for {number}. Fetch request returned a status of {res.status_code}",
fg="yellow",
)
return None
res.raise_for_status()
data = res.json()
if not data["body"]:
data["body"] = ""
if not data:
return None
pr = msgspec.convert(data, type=PullRequest)
cc_prefix, clean_title = pr.title.split(":", maxsplit=1)
cc_type = cc_prefix.split("(", maxsplit=1)[0].lower()
closes_issues = await self.get_closing_issues_references(pr_number=pr.number)
return PRInfo(
number=pr.number,
cc_type=cc_type,
clean_title=clean_title.strip(),
url=f"https://github.com/litestar-org/advanced-alchemy/pull/{pr.number}",
closes=closes_issues,
title=pr.title,
created_at=datetime.datetime.strptime(pr.created_at, "%Y-%m-%dT%H:%M:%S%z"),
description=pr.body,
user=pr.user,
)
async def get_prs(self) -> dict[str, list[PRInfo]]:
res = await self._api_client.get(f"/compare/{self._base}...{self._release_branch}")
res.raise_for_status()
compares = msgspec.convert(res.json()["commits"], list[Comp])
pr_numbers = list(filter(None, (_pr_number_from_commit(c) for c in compares)))
pulls = await asyncio.gather(*map(self._get_pr_info_for_pr, pr_numbers))
prs: dict[str, list[PRInfo]] = defaultdict(list)
for pr in pulls:
if not pr:
continue
if pr.user.type != "Bot":
prs[pr.cc_type].append(pr)
return prs
async def _get_first_time_contributions(self, prs: dict[str, list[PRInfo]]) -> list[PRInfo]:
# there's probably a way to peel this information out of the GraphQL API but
# this was easier to implement, and it works well enough ¯\_(ツ)_/¯
# the logic is: if we don't find a commit to the main branch, dated before the
# first commit within this release, it's the user's first contribution
prs_by_user_login: dict[str, list[PRInfo]] = defaultdict(list)
for pr in [p for type_prs in prs.values() for p in type_prs]:
prs_by_user_login[pr.user.login].append(pr)
first_prs: list[PRInfo] = []
async def is_user_first_commit(user_login: str) -> None:
first_pr = sorted(prs_by_user_login[user_login], key=lambda p: p.created_at)[0]
res = await self._api_client.get(
"/commits",
params={
"author": user_login,
"sha": "main",
"until": first_pr.created_at.isoformat(),
"per_page": 1,
},
)
res.raise_for_status()
if len(res.json()) == 0:
first_prs.append(first_pr)
await asyncio.gather(*map(is_user_first_commit, prs_by_user_login.keys()))
return first_prs
async def get_release_info(self) -> ReleaseInfo:
prs = await self.get_prs()
first_time_contributors = await self._get_first_time_contributions(prs)
return ReleaseInfo(
pull_requests=prs,
first_time_prs=first_time_contributors,
base=self._base,
release_tag=self._new_release_tag,
version=self._new_release_version,
)
async def create_draft_release(self, body: str, release_branch: str) -> str:
res = await self._api_client.post(
"/releases",
json={
"tag_name": self._new_release_tag,
"target_commitish": release_branch,
"name": self._new_release_tag,
"draft": True,
"body": body,
},
)
res.raise_for_status()
return res.json()["html_url"] # type: ignore[no-any-return]
class GHReleaseWriter:
def __init__(self) -> None:
self.text = ""
def add_line(self, line: str) -> None:
self.text += line + "\n"
def add_pr_descriptions(self, infos: list[PRInfo]) -> None:
for info in infos:
self.add_line(f"* {info.title} by @{info.user.login} in {info.url}")
class ChangelogEntryWriter:
def __init__(self) -> None:
self.text = ""
self._level = 0
self._indent = " "
self._cc_type_map = {"fix": "bugfix", "feat": "feature"}
def add_line(self, line: str) -> None:
self.text += (self._indent * self._level) + line + "\n"
def add_change(self, pr: PRInfo) -> None:
with self.directive(
"change",
arg=pr.clean_title,
type=self._cc_type_map.get(pr.cc_type, "misc"),
pr=str(pr.number),
issue=", ".join(map(str, pr.closes)),
):
self.add_line("")
for line in pr.description.splitlines():
self.add_line(line)
@contextlib.contextmanager
def directive(self, name: str, arg: Optional[str] = None, **options: str) -> Generator[None, None, None]:
self.add_line(f".. {name}:: {arg or ''}")
self._level += 1
for key, value in options.items():
if value:
self.add_line(f":{key}: {value}")
yield
self._level -= 1
self.add_line("")
def build_gh_release_notes(release_info: ReleaseInfo) -> str:
# this is for the most part just recreating GitHub's autogenerated release notes
# but with three important differences:
# 1. PRs are sorted into categories
# 2. The conventional commit type is stripped from the title
# 3. It works with our release branch process. GitHub doesn't pick up (all) commits
# made there depending on how things were merged
doc = GHReleaseWriter()
# doc.add_line("## Sponsors 🌟") # noqa: ERA001
# doc.add_line(f"- A huge 'Thank you!' to all sponsors across {_polar}, {_open_collective} and {_github_sponsors}!") # noqa: ERA001
doc.add_line("## What's changed")
if features := release_info.pull_requests.get("feat"):
doc.add_line("\n### New features 🚀")
doc.add_pr_descriptions(features)
if fixes := release_info.pull_requests.get("fix"):
doc.add_line("\n### Bugfixes 🐛")
doc.add_pr_descriptions(fixes)
if release_info.first_time_prs:
doc.add_line("\n## New contributors 🎉")
for pr in release_info.first_time_prs:
doc.add_line(f"* @{pr.user.login} made their first contribution in {pr.url}")
ignore_sections = {"fix", "feat", "ci", "chore"}
if other := [pr for k, prs in release_info.pull_requests.items() if k not in ignore_sections for pr in prs]:
doc.add_line("\n<!-- Review these: Not all of them should go into the release notes -->")
doc.add_line("### Other changes")
doc.add_pr_descriptions(other)
doc.add_line("\n**Full Changelog**")
doc.add_line(release_info.compare_url)
return doc.text
def build_changelog_entry(release_info: ReleaseInfo, interactive: bool = False) -> str:
doc = ChangelogEntryWriter()
with doc.directive("changelog", release_info.version):
doc.add_line(f":date: {datetime.datetime.now(tz=datetime.timezone.utc).date().isoformat()}")
doc.add_line("")
change_types = {"fix", "feat"}
for prs in release_info.pull_requests.values():
for pr in prs:
cc_type = pr.cc_type
if cc_type in change_types or (interactive and click.confirm(f"Include PR #{pr.number} {pr.title!r}?")):
doc.add_change(pr)
else:
click.secho(f"Ignoring change with type {cc_type}", fg="yellow")
return doc.text
def _get_gh_token() -> str:
if gh_token := os.getenv("GH_TOKEN"):
click.secho("Using GitHub token from env", fg="blue")
return gh_token
gh_executable = shutil.which("gh")
if not gh_executable:
click.secho("GitHub CLI not installed", fg="yellow")
else:
click.secho("Using GitHub CLI to obtain GitHub token", fg="blue")
proc = subprocess.run([gh_executable, "auth", "token"], check=True, capture_output=True, text=True) # noqa: S603
if out := (proc.stdout or "").strip():
return out
click.secho("Could not find any GitHub token", fg="red")
sys.exit(1)
def _get_latest_tag() -> str:
click.secho("Using latest tag", fg="blue")
return subprocess.run( # noqa: S602
"git tag --sort=taggerdate | tail -1", # noqa: S607
check=True,
capture_output=True,
text=True,
shell=True,
).stdout.strip()
def _write_changelog_entry(changelog_entry: str) -> None:
changelog_path = pathlib.Path("docs/changelog.rst")
changelog_lines = changelog_path.read_text().splitlines()
line_no = next(
(i for i, line in enumerate(changelog_lines) if line.startswith(".. changelog::")),
None,
)
if not line_no:
msg = "Changelog start not found"
raise ValueError(msg)
changelog_lines[line_no:line_no] = changelog_entry.splitlines()
changelog_path.write_text("\n".join(changelog_lines))
def update_pyproject_version(new_version: str) -> None:
# can't use tomli-w / tomllib for this as is messes up the formatting
pyproject = pathlib.Path("pyproject.toml")
content = pyproject.read_text()
content = re.sub(r'(\nversion ?= ?")\d+\.\d+\.\d+("\s*\n)', rf"\g<1>{new_version}\g<2>", content)
pyproject.write_text(content)
@click.command()
@click.argument("version")
@click.option("--base", help="Previous release tag. Defaults to the latest tag")
@click.option("--branch", help="Release branch", default="main")
@click.option(
"--gh-token",
help="GitHub token. If not provided, read from the GH_TOKEN env variable. "
"Alternatively, if the GitHub CLI is installed, it will be used to fetch a token",
)
@click.option(
"-i",
"--interactive",
is_flag=True,
help="Interactively decide which commits should be included in the release notes",
default=False,
)
@click.option("-c", "--create-draft-release", is_flag=True, help="Create draft release on GitHub")
def cli(
base: Optional[str],
branch: str,
version: str,
gh_token: Optional[str],
interactive: bool,
create_draft_release: bool,
) -> None:
if gh_token is None:
gh_token = _get_gh_token()
if base is None:
base = _get_latest_tag()
if not re.match(r"\d+\.\d+\.\d+", version):
click.secho(f"Invalid version: {version!r}")
sys.exit(1)
new_tag = f"v{version}"
click.secho(f"Creating release notes for tag {new_tag}, using {base} as a base", fg="cyan")
thing = _Thing(gh_token=gh_token, base=base, release_branch=branch, tag=new_tag, version=version)
loop = asyncio.new_event_loop()
release_info = loop.run_until_complete(thing.get_release_info())
gh_release_notes = build_gh_release_notes(release_info)
changelog_entry = build_changelog_entry(release_info, interactive=interactive)
click.secho("Writing changelog entry", fg="green")
_write_changelog_entry(changelog_entry)
if create_draft_release:
click.secho("Creating draft release", fg="blue")
release_url = loop.run_until_complete(thing.create_draft_release(body=gh_release_notes, release_branch=branch))
click.echo(f"Draft release available at: {release_url}")
else:
click.echo(gh_release_notes)
loop.close()
if __name__ == "__main__":
cli()
|