Function write_changelog

scripts/prepare_release.py:227–259

Write a changelog draft for the release. Args: version: Release version without the leading `v`. commits: Commit subject lines to include as the first changelog draft. Returns: Path to the created changelog file. Raises: ReleaseError: The changelog file

(version: str, commits: list[str])

def write_changelog(version: str, commits: list[str]) -> Path:
    """Write a changelog draft for the release.

    Args:
        version: Release version without the leading `v`.
        commits: Commit subject lines to include as the first changelog draft.

    Returns:
        Path to the created changelog file.

    Raises:
        ReleaseError: The changelog file already exists.
    """
    changelog_path = REPO_ROOT / "changelogs" / f"v{version}.md"
    if changelog_path.exists():
        raise ReleaseError(f"Changelog already exists: {changelog_path}")

    changelog_path.parent.mkdir(parents=True, exist_ok=True)
    entries = [f"- {commit}" for commit in commits] or ["- "]
    changelog_path.write_text(
        "\n".join(
            [
                "## What's Changed",
                "",
                "<!-- Review, group, and polish these entries before publishing. -->",
                "",
                *entries,
                "",
            ]
        ),
        encoding="utf-8",
    )
    return changelog_path


def create_release_branch(version: str, base_branch: str, remote: str) -> str: