chore: use cog for quick README updates (#2428)

* chore: use cog for quick README updates Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> * refactor: rename scripts Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com> --------- Signed-off-by: Henry Schreiner <henryschreineriii@gmail.com>
2025-05-28 23:36:16 -04:00
parent 2d6c328457
commit b9f1942e8d
5 changed files with 41 additions and 100 deletions
@@ -0,0 +1,23 @@
+#!/usr/bin/env python3
+
+import re
+from pathlib import Path
+
+PROJECT_ROOT = Path(__file__).parent / ".."
+CHANGELOG_FILE = PROJECT_ROOT / "docs" / "changelog.md"
+
+# https://regexr.com/622ds
+FIRST_5_CHANGELOG_ENTRIES_REGEX = re.compile(r"""(^###.*?(?=###)){5}""", re.DOTALL | re.MULTILINE)
+
+
+def mini_changelog() -> str:
+    changelog_text = CHANGELOG_FILE.read_text()
+
+    mini_changelog_match = FIRST_5_CHANGELOG_ENTRIES_REGEX.search(changelog_text)
+    assert mini_changelog_match, "Failed to find the first few changelog entries"
+
+    return f"\n{mini_changelog_match.group(0).strip()}\n"
+
+
+if __name__ == "__main__":
+    print(mini_changelog())