chore: add CHANGELOG.md (#44)

CHANGELOG.md

@@ -0,0 +1,165 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+## [unreleased]
+
+### 📚 Documentation
+
+- Add instructions for installing on Arch Linux (#43)
+
+## [0.5.0] - 2024-11-18
+
+### 🚀 Features
+
+- *(cli)* Allow passing passthrough keybindings via stdout for the parent process to deal with (#39)
+- *(ui)* Make the top UI help bar toggleable (#41)
+
+### 🚜 Refactor
+
+- *(config)* [**breaking**] Make action names snake case in keybinding configuration (#40)
+
+### 📚 Documentation
+
+- Update README television version
+- Update README television version specifier
+- Update README television version
+
+### ⚙️ Miscellaneous Tasks
+
+- *(rustfmt)* Update rustfmt.toml (#42)
+
+## [0.4.23] - 2024-11-16
+
+### 🚀 Features
+
+- *(ui)* Make help bar display optional (#35)
+
+### 🚜 Refactor
+
+- *(configuration)* Modularize code and better handling of default options (#32)
+
+### 📚 Documentation
+
+- *(debian)* Add installation docs for debian-based systems (#33)
+- *(config)* Update docs default configuration (#34)
+
+## [0.4.22] - 2024-11-16
+
+### 🐛 Bug Fixes
+
+- *(ghactions)* Only trigger cd workflow on new tags (#22)
+- *(config)* Swap out default keymaps with user defined ones instead of stacking (#26)
+
+### 🚜 Refactor
+
+- *(channels)* Converting between entries and channels is now generic over channels (#25)
+
+### ⚙️ Miscellaneous Tasks
+
+- *(deb)* Release deb package for television (#31)
+- Update CD workflow
+- *(cd)* Fix cd configuration for deb packages
+- *(cd)* Fix cd configuration for deb packages
+- *(versions)* Bump workspace crates versions
+
+## [0.4.21] - 2024-11-13
+
+### 🐛 Bug Fixes
+
+- *(windows)* #20 respect `TELEVISION_CONFIG` env var on windows (#21)
+
+### ⚙️ Miscellaneous Tasks
+
+- *(nix)* Nix flake shell + rust-toolchain.toml setup (#14)
+
+## [0.4.20] - 2024-11-11
+
+### 🐛 Bug Fixes
+
+- *(windows)* Ignore `KeyEventKind::Release` events (#3)
+- *(windows)* Bump television_utils to v0.0.1 (#4)
+- *(config)* More consistent configuration file location for linux and macos (#9)
+- *(workspace)* Fix cargo workspace dependencies
+- *(cargo workspace)* Fix cargo workspace structure and dependencies (#15)
+
+### 🚜 Refactor
+
+- *(workspace)* Reorganize cargo workspace (#12)
+
+### 📚 Documentation
+
+- Add terminal emulators compatibility status
+- Fix table alignments
+- *(readme)* Update terminal emulators compatibility list (#6)
+
+### ⚡ Performance
+
+- *(preview)* Remove temporary plaintext previews in favor of loading message preview (#10)
+
+### ⚙️ Miscellaneous Tasks
+
+- Update README.md install section
+- *(coc)* Create CODE_OF_CONDUCT.md (#7)
+- *(crate)* Add include directives to Cargo.toml to make the crate leaner (#11)
+
+## [0.4.18] - 2024-11-10
+
+### 🐛 Bug Fixes
+
+- Add the correct permissions to release binaries
+- Add `winapi-util` dependency for windows builds
+
+## [0.4.17] - 2024-11-10
+
+### ⚙️ Miscellaneous Tasks
+
+- Udate documentation and dependencies
+- Update Makefile and CONTRIBUTING.md
+- Testing out the CD pipeline
+
+## [0.4.15] - 2024-11-10
+
+### 🚀 Features
+
+- Send to channel
+- More syntaxes and themes for highlighting + configuration
+
+### 🐛 Bug Fixes
+
+- Filtering system directories in gitrepos
+- Stabilize preview scroll initialization
+- Doctests imports
+- Gag stdout and stderr while loading theme assets to silence bat warning
+
+### 🚜 Refactor
+
+- Extract matcher logic into separate crate
+- Split project into separate crates
+- More refactoring and fixing doctests
+
+### 📚 Documentation
+
+- Update README.md
+- Add default keybindings to README.md
+- Some work on CONTRIBUTING.md
+- More work on CONTRIBUTING.md
+
+### ⚙️ Miscellaneous Tasks
+
+- Bump version
+- Bump version
+- Unused imports and ci docs
+- Update dependencies and bump version
+- Update dependencies and bump version
+- Bump version
+- Update dependencies and bump version
+- Makefile and dist scripts
+- *(precommit)* Don't allow committing if clippy doesn't pass
+- Patch
+- Update workspace crates configurations
+- *(previewers)* Unused attributes
+- Add license to syntax snippet
+- Bump version
+
+<!-- generated by git-cliff -->

cliff.toml

@@ -0,0 +1,83 @@
+# 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
+]
+# render body even when there are no releases to process
+# render_always = true
+# output file path
+# output = "test.md"
+
+[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"