docs: fix rst changelog

camille-004 · Dec 5, 2024 · d110f08 · d110f08
1 parent 0243fcc
commit d110f08
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 3 deletions.
diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -8,7 +8,7 @@
 project = "nanofed"
 copyright = "2024, Camille Dunning"
 author = "Camille Dunning"
-release = "0.1.0"
+release = "0.1.1"
 
 # -- General configuration
 extensions = [

diff --git a/scripts/changelog.py b/scripts/changelog.py
@@ -115,10 +115,30 @@ def generate_rst_changelog(
 
         changelog_items = []
 
+        type_headers = {
+            "feat": "🎁 Features",
+            "fix": "🐛 Bug Fixes",
+            "docs": "📚 Documentation",
+            "style": "🎨 Style",
+            "refactor": "♻️ Code Refactoring",
+            "perf": "⚡ Performance",
+            "test": "🧪 Tests",
+            "build": "📦 Build System",
+            "ci": "🔄 CI Changes",
+            "chore": "🔧 Maintenance",
+            "other": "📝 Other Changes",
+        }
+
         for category, commits in categories.items():
             if commits:
-                changelog_items.append(f"{category.title()}")
-                changelog_items.append("~" * (len(category) + 2))
+                header = type_headers.get(category, category.title())
+                changelog_items.append(f"{header}")
+                underline_length = (
+                    len(header.split(" ", 1)[1])
+                    if " " in header
+                    else len(header)
+                )
+                changelog_items.append("~" * underline_length)
                 changelog_items.append("")
 
                 for commit in commits:
@@ -139,6 +159,7 @@ def generate_rst_changelog(
         content = content.replace(
             ".. Generated automatically from git commits", changelog_section
         )
+        return content
 
     def generate_md_changelog(
         self, version: str, categories: dict[str, list[dict[str, str]]]