docs: add git-cliff changelog

CHANGELOG.md

@@ -0,0 +1,176 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [0.15.1] - 2024-09-21
+
+### 🐛 Bug Fixes
+
+- Set pr reviews to the right colour
+
+## [0.15.0] - 2024-09-19
+
+### 🐛 Bug Fixes
+
+- Handle repo rename/transfer correctly
+
+## [0.14.0] - 2024-09-19
+
+### 🚀 Features
+
+- Refactor with octocrab (#12)
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version
+
+## [0.13.0] - 2024-09-18
+
+### 🚀 Features
+
+- Hash action too
+
+## [0.12.0] - 2024-09-18
+
+### 🚀 Features
+
+- Support team `membership` changes (#10)
+- Use catppuccin colours in embeds (#11)
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version
+
+## [0.11.0] - 2024-09-18
+
+### 🚀 Features
+
+- Support `pull_request_review` (#7)
+
+### 🐛 Bug Fixes
+
+- `issue_comment` can also be on pull requests (#8)
+
+### 🚜 Refactor
+
+- Ignore most issue events (#6)
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump to 0.11.0 (#9)
+
+## [0.10.0] - 2024-09-16
+
+### 🐛 Bug Fixes
+
+- Replace underscores instead of hyphens in actions (#5)
+- Silly mistake & run tests in CI
+
+### 🚜 Refactor
+
+- *(PR)* Ignore events besides `opened`, `closed` & `reopened` (#4)
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version
+
+## [0.9.0] - 2024-09-15
+
+### 🚀 Features
+
+- Replace - with space in actions
+
+## [0.8.0] - 2024-09-15
+
+### 🚀 Features
+
+- Ignore all edited events
+
+## [0.7.0] - 2024-09-15
+
+### 🐛 Bug Fixes
+
+- Limit length of `description` embed field (#3)
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version number
+
+## [0.6.0] - 2024-09-14
+
+### 🚀 Features
+
+- Maybe fix comments a bit
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version number
+
+## [0.5.1] - 2024-09-14
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump to 0.5.1 (#2)
+
+## [0.5.0] - 2024-09-14
+
+### 📚 Documentation
+
+- *(readme)* Rename
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version number
+
+### Build
+
+- Rename package
+- "waaaahhh" - @sgoudham
+
+## [0.4.0] - 2024-06-11
+
+### 🚀 Features
+
+- Implement all the github events we care about
+
+### ⚙️ Miscellaneous Tasks
+
+- Enable & fix clippy lints
+- Bump version number
+
+## [0.3.0] - 2024-06-11
+
+### 🚀 Features
+
+- Make port configurable
+
+### 📚 Documentation
+
+- Add readme
+
+### ⚙️ Miscellaneous Tasks
+
+- Add license
+- Bump version number
+
+## [0.2.0] - 2024-06-11
+
+### 🚀 Features
+
+- Support separate bot hook
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version number
+
+## [0.1.0] - 2024-06-11
+
+### 🚀 Features
+
+- Initial commit
+
+### ⚙️ Miscellaneous Tasks
+
+- Add release workflow
+
+<!-- generated by git-cliff -->

cliff.toml

@@ -0,0 +1,79 @@
+# git-cliff ~ default configuration file
+# https://git-cliff.org/docs/configuration
+#
+# Lines starting with "#" are comments.
+# Configuration options are organized into tables and keys.
+# See documentation for more information on available options.
+
+[changelog]
+# template for the changelog header
+header = """
+# Changelog\n
+All notable changes to this project will be documented in this file.\n
+"""
+# template for the changelog body
+# https://keats.github.io/tera/docs/#introduction
+body = """
+{% if version %}\
+    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+{% else %}\
+    ## [unreleased]
+{% endif %}\
+{% for group, commits in commits | group_by(attribute="group") %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits %}
+        - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
+            {% if commit.breaking %}[**breaking**] {% endif %}\
+            {{ commit.message | upper_first }}\
+    {% endfor %}
+{% endfor %}\n
+"""
+# template for the changelog footer
+footer = """
+<!-- generated by git-cliff -->
+"""
+# remove the leading and trailing s
+trim = true
+# postprocessors
+postprocessors = [
+  # { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL
+]
+
+[git]
+# parse the commits based on https://www.conventionalcommits.org
+conventional_commits = true
+# filter out the commits that are not conventional
+filter_unconventional = true
+# process each line of a commit as an individual commit
+split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # Replace issue numbers
+  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  # Check spelling of the commit with https://github.com/crate-ci/typos
+  # If the spelling is incorrect, it will be automatically fixed.
+  #{ pattern = '.*', replace_command = 'typos --write-changes -' },
+]
+# regex for parsing and grouping commits
+commit_parsers = [
+  { message = "^feat", group = "<!-- 0 -->🚀 Features" },
+  { message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
+  { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
+  { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
+  { message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },
+  { message = "^style", group = "<!-- 5 -->🎨 Styling" },
+  { message = "^test", group = "<!-- 6 -->🧪 Testing" },
+  { message = "^chore\\(release\\): prepare for", skip = true },
+  { message = "^chore\\(deps.*\\)", skip = true },
+  { message = "^chore\\(pr\\)", skip = true },
+  { message = "^chore\\(pull\\)", skip = true },
+  { message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },
+  { body = ".*security", group = "<!-- 8 -->🛡️ Security" },
+  { message = "^revert", group = "<!-- 9 -->◀️ Revert" },
+]
+# filter out the commits that are not matched by commit parsers
+filter_commits = false
+# sort the tags topologically
+topo_order = false
+# sort the commits inside sections by oldest/newest order
+sort_commits = "oldest"