refactor: make the release script create GitHub releases

Author: leodevian

changelog.d/+626d22d0.changed.md

@@ -0,0 +1 @@
+Make `scripts/release.py` create GitHub releases.

template/scripts/release.py.jinja

@@ -10,15 +10,14 @@
 {%- endif %}
 # ]
 # ///
-"""Make a release."""
+"""Create a release."""
 
 # ruff: noqa: T201
 
 from __future__ import annotations
 
 import argparse
 {%- if not dynamic_version %}
-import enum
 import json
 {%- endif %}
 import subprocess
@@ -40,21 +39,7 @@ run = partial(
     stderr=subprocess.DEVNULL,
 )
 
-{% if not dynamic_version %}
-class Bump(enum.StrEnum):
-    """The enumeration of supported version bump semantics."""
-
-    MAJOR = enum.auto()
-    MINOR = enum.auto()
-    PATCH = enum.auto()
-    STABLE = enum.auto()
-    ALPHA = enum.auto()
-    BETA = enum.auto()
-    RC = enum.auto()
-    POST = enum.auto()
-    DEV = enum.auto()
 
-{% endif %}
 def create_parser() -> argparse.ArgumentParser:
     """Create the argument parser."""
     parser = argparse.ArgumentParser(description="make a release")
@@ -72,8 +57,6 @@ def create_parser() -> argparse.ArgumentParser:
     )
     mutex.add_argument(
         "--bump",
-        type=Bump,
-        choices=Bump,
         help="update the version using the given semantics",
     )
 {%- endif %}
@@ -156,10 +139,22 @@ def switch_to_branch(branch: str) -> Generator[None]:
         print(f"Removed branch {branch!r} and switched back to {base_branch!r}.")
 
 
-def build_changelog(version: str) -> None:
-    """Build the changelog."""
+def get_release_notes(version: str) -> str:
+    """Return the release notes."""
+    release_notes = subprocess.check_output(
+        ("towncrier", "build", "--version", version, "--draft"),
+        stderr=subprocess.DEVNULL,
+        text=True,
+    ).rstrip()
+    release_notes = "".join(release_notes.splitlines(keepends=True)[1:])
+    release_notes = release_notes.strip()
+    return f"## Release notes\n\n{release_notes}"
+
+
+def update_changelog(version: str) -> None:
+    """Update the changelog."""
     try:
-        run(("towncrier", "build", "--yes", "--version", version))
+        run(("towncrier", "build", "--version", version, "--yes"))
 
     except subprocess.CalledProcessError:
         print_err("An error occurred while building the changelog.")
@@ -182,14 +177,13 @@ def create_release_tag(version: str) -> str:
     return release_tag
 
 
-def push_changes(branch: str, remote_branch: str = "main") -> None:
-    """Push the changes to the origin remote."""
-    run(("git", "push", "origin", f"{branch}:{remote_branch}", "--follow-tags"))
-    print(f"Pushed changes from {branch!r} to 'origin/{remote_branch}'.")
+def create_release(release_tag: str, release_notes: str) -> None:
+    """Create the GitHub release."""
+    run(("gh", "release", "create", release_tag, "--notes", release_notes))
 
 
 def main(argv: Sequence[str] | None = None) -> int:
-    """Prepare a new release."""
+    """Create a release."""
     parser = create_parser()
     args = parser.parse_args(argv)
 
@@ -202,13 +196,14 @@ def main(argv: Sequence[str] | None = None) -> int:
     release_branch = f"release/{version}"
 
     with switch_to_branch(release_branch):
-        build_changelog(version)
+        release_notes = get_release_notes(version)
+        update_changelog(version)
 
         # Commit changes.
 {%- if not dynamic_version %}
         run(("git", "add", ":/pyproject.toml", ":/uv.lock"))
 {%- endif %}
-        run(("git", "add", "-A", ":/changelog.d/*", ":/CHANGELOG.md"))
+        run(("git", "add", "-A", ":/changelog.d", ":/CHANGELOG.md"))
         message = f"chore: prepare release {version}"
         run(("git", "commit", "--no-verify", "-m", message))
         print(f"Committed changes on branch {release_branch!r}.")
@@ -222,7 +217,13 @@ def main(argv: Sequence[str] | None = None) -> int:
             print(f"Removed release tag {release_tag!r}.")
             return 0
 
-        push_changes(release_branch, "main")
+        run(
+            ("git", "push", "--atomic", "origin", f"{release_branch}:main", release_tag)
+        )
+        print(f"Pushed changes from branch {release_branch!r} to branch 'origin/main'.")
+        print(f"Pushed release tag {release_tag!r} to the origin remote.")
+
+        create_release(release_tag, release_notes)
 
     # Switch to the main branch.
     run(("git", "checkout", "main"))