Auto-generate release notes

Author: stephanlensky

.github/workflows/docs.yml

@@ -22,8 +22,9 @@ jobs:
         run: uv python install
       - name: Install dependencies
         run: uv sync --all-extras --dev
-      - name: Generate API reference docs
+      - name: Auto-generate docs
         run: |
           uv run python scripts/mkdocs_generate_reference.py
+          uv run python scripts/mkdocs_generate_release_notes.py
       - name: Deploy to GitHub Pages
         run: uv run mkdocs gh-deploy --force

.gitignore

@@ -1,6 +1,9 @@
-# mkdocs
+# mkdocs build
 site/
+
+# auto-generated docs
 docs/reference
+docs/release-notes.md
 
 # uv/pyenv
 .python-version

scripts/mkdocs_generate_release_notes.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env -S uv run
+from pathlib import Path
+
+REPO_ROOT = Path(__file__).parent.parent
+CHANGELOG_MD = REPO_ROOT / "CHANGELOG.md"
+RELEASE_NOTES_MD = REPO_ROOT / "docs" / "release-notes.md"
+
+
+def get_releases() -> str:
+    with CHANGELOG_MD.open() as f:
+        changelog_md = f.read()
+
+    sections = changelog_md.split("\n## ")[1:]
+    unreleased = sections.pop(0)
+    # small sanity check
+    if not unreleased.startswith("[Unreleased]"):
+        raise ValueError("Unexpected CHANGELOG.md format, aborting!")
+
+    return "\n\n".join(f"## {section.strip()}" for section in sections)
+
+
+def main() -> None:
+    releases = get_releases()
+
+    release_notes_md = f"# Release Notes\n\n{releases}\n"
+
+    with RELEASE_NOTES_MD.open("w") as f:
+        f.write(release_notes_md)
+
+
+if __name__ == "__main__":
+    main()