chore: add towncrier to manage product-level changelog

aravinda0 · Jun 13, 2024 · 860c196 · 860c196
1 parent f3163f7
commit 860c196
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,4 @@
+## qtile-bonsai v0.1.0 (2024-05-05)
+                                   
+First official release. Too many things to list - should have launched way
+earlier.
diff --git a/newsfragments/.gitignore b/newsfragments/.gitignore
@@ -0,0 +1 @@
+!.gitignore
diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -58,6 +58,7 @@ dev = [
     "jinja2>=3.1.3",
     "ptpython>=3.0.25",
     "basedpyright>=1.12.3",
+    "towncrier>=23.11.0",
 ]
 
 
@@ -128,3 +129,31 @@ lines-after-imports = 2
 # Disabling the following due to conflict with ruff formatter
 # See: https://docs.astral.sh/ruff/formatter/#conflicting-lint-rules
 split-on-trailing-comma = false
+
+
+[tool.towncrier]
+directory = "newsfragments"
+filename = "CHANGELOG.md"
+package = "qtile_bonsai"
+title_format = "## qtile-bonsai v{version} ({project_date})"
+underlines = " "
+
+[[tool.towncrier.type]]
+directory = "breaking"
+name = "Breaking Changes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "feat"
+name = "Features & Improvements"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "fix"
+name = "Fixes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "misc"
+name = "Miscellaneous"
+showcontent = true