From 270c0e6b6e729a349b61a512def02433d3675cc9 Mon Sep 17 00:00:00 2001
From: Adam Perkowski <adas1per@protonmail.com>
Date: Sun, 17 Nov 2024 04:38:08 +0100
Subject: [PATCH] docs: some `git-cliff` improvements

---
 CHANGELOG.md | 61 ++++++++++++++++++++++++++++++++++++----------------
 cliff.toml   | 11 +++++-----
 2 files changed, 49 insertions(+), 23 deletions(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 1483cf7..99e85a9 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -2,34 +2,59 @@
 
 All notable changes to nvrs will be documented in this file.
 
+## [upstream]
+
+### 🚀 Features
+
+- `--nuke` functionality + some minor fixes ([6949ec0](https://github.com/adamperkowski/nvrs/commit/6949ec0c36c3634dafd0123b5ee7cbd4c092e0c9))
+- add `--version` & about ([50f2bc2](https://github.com/adamperkowski/nvrs/commit/50f2bc246aa32b0f50fb3aa55580c56559c5ee64))
+
+### 🐛 Bug Fixes
+
+- (*ui*) wrong --cmp output characters<br><br>`|` -> `*` ([3cad4c1](https://github.com/adamperkowski/nvrs/commit/3cad4c1dd94f54c176d894e32c4f7ef384c6d8dd))
+- (*config*) make `prefix` optional ([7b942cc](https://github.com/adamperkowski/nvrs/commit/7b942cc6b9f7c5ac551837e7f53425df34ccb3a9))
+
+### 📚 Documentation
+
+- add a banner & move `speed` to `features` ([752fc15](https://github.com/adamperkowski/nvrs/commit/752fc158b118de603a9f2a9f31a0c320fb3cf78a))
+- add a manpage ([073c98f](https://github.com/adamperkowski/nvrs/commit/073c98ff097283fae09742c77bb98358d706bb22))
+
+### ⚡ Performance
+
+- drastically decrease bin size & increase performance<br><br>4.7M -> 1.8M<br>0.2s -> 0.02s ([460f9d9](https://github.com/adamperkowski/nvrs/commit/460f9d9bbe6928d34948ecb3eec7fd0c6c4b7ba4))
+
+### Other (unconventional)
+
+- change the `--take` character<br><br>`*` -> `+` ([0aace9d](https://github.com/adamperkowski/nvrs/commit/0aace9de0f2c3f26eda4de9491a3454929398102))
+
 ## [0.1.0] - 2024-11-16
 
 ### 🐛 Bug Fixes
 
-- *(hot)* a typo in `custom_error` ([4844515](48445157be6b3ae9ca97d6c79f25b20529e30fd7))
+- (*hot*) a typo in `custom_error` ([4844515](https://github.com/adamperkowski/nvrs/commit/48445157be6b3ae9ca97d6c79f25b20529e30fd7))
 
 ### ⚙️ Refactoring
 
-- *(custom_error)* improve newline control (#1) ([05faaca](05faaca79dd1306a818864ab80ae028a0217dd1e))
+- (*custom_error*) improve newline control ([#1](https://github.com/adamperkowski/nvrs/issues/1))<br><br>nwm co robie ([05faaca](https://github.com/adamperkowski/nvrs/commit/05faaca79dd1306a818864ab80ae028a0217dd1e))
 
 ### ⚙️ Miscellaneous Tasks
 
-- GitHub stuff ([eda40d8](eda40d8d68c4c13d24ad2b9b0acd217c02ee889e))
-- run git-cliff on schedule ([c18f152](c18f15256d041c17f1a47e6310c08ce23fc286f2))
-- exclude `CHANGELOG.md` from `typos` ([bbdd835](bbdd83543aa49be2ca690e767d42d5572e3ee2a8))
+- GitHub stuff ([eda40d8](https://github.com/adamperkowski/nvrs/commit/eda40d8d68c4c13d24ad2b9b0acd217c02ee889e))
+- run git-cliff on schedule ([c18f152](https://github.com/adamperkowski/nvrs/commit/c18f15256d041c17f1a47e6310c08ce23fc286f2))
+- exclude `CHANGELOG.md` from `typos` ([bbdd835](https://github.com/adamperkowski/nvrs/commit/bbdd83543aa49be2ca690e767d42d5572e3ee2a8))
 
 ### Other (unconventional)
 
-- init ([4ca8ba6](4ca8ba6f390d668e8d13caa0214f97c09115d4c3))
-- set up workflows ([86933da](86933da3817c26fa3caa6a84bb3ecf4c4d2cae2a))
-- rebranding ([b927a53](b927a536fddbde155979ef03ef0b800906ef777b))
-- cli args ([97cca62](97cca6211308b3eef82f16e8289527e7490f10a4))
-- config ([b03dc12](b03dc12e3686f0ef5e21f43731189a771d08d475))
-- github api ([9c92e24](9c92e24d3a2a82eaaf84f3b37ce342a8b88181cd))
-- better cli ([683ffd7](683ffd77f6fc03067b9929ee4c50f3c8600e75ff))
-- custom configs ([51b78ba](51b78baf83eb9f1fb2190974a2668263d1ce2e6c))
-- verfiles + updating ([345f8fd](345f8fda053074c150e7595e611b8d44dd603786))
-- new entry saving ([62075ec](62075ecdb5d4666b6b3fec6e02c42913f544c75c))
-- compare & take ([18d538f](18d538f738be4060fb65388cb822f09c8e00aebf))
-
-<!-- generated by git-cliff :) -->
+- init ([4ca8ba6](https://github.com/adamperkowski/nvrs/commit/4ca8ba6f390d668e8d13caa0214f97c09115d4c3))
+- set up workflows ([86933da](https://github.com/adamperkowski/nvrs/commit/86933da3817c26fa3caa6a84bb3ecf4c4d2cae2a))
+- rebranding ([b927a53](https://github.com/adamperkowski/nvrs/commit/b927a536fddbde155979ef03ef0b800906ef777b))
+- cli args ([97cca62](https://github.com/adamperkowski/nvrs/commit/97cca6211308b3eef82f16e8289527e7490f10a4))
+- config ([b03dc12](https://github.com/adamperkowski/nvrs/commit/b03dc12e3686f0ef5e21f43731189a771d08d475))
+- github api ([9c92e24](https://github.com/adamperkowski/nvrs/commit/9c92e24d3a2a82eaaf84f3b37ce342a8b88181cd))
+- better cli ([683ffd7](https://github.com/adamperkowski/nvrs/commit/683ffd77f6fc03067b9929ee4c50f3c8600e75ff))
+- custom configs ([51b78ba](https://github.com/adamperkowski/nvrs/commit/51b78baf83eb9f1fb2190974a2668263d1ce2e6c))
+- verfiles + updating ([345f8fd](https://github.com/adamperkowski/nvrs/commit/345f8fda053074c150e7595e611b8d44dd603786))
+- new entry saving ([62075ec](https://github.com/adamperkowski/nvrs/commit/62075ecdb5d4666b6b3fec6e02c42913f544c75c))
+- compare & take ([18d538f](https://github.com/adamperkowski/nvrs/commit/18d538f738be4060fb65388cb822f09c8e00aebf))
+
+<sub>generated by [git-cliff](https://github.com/orhun/git-cliff) :)</sub>
diff --git a/cliff.toml b/cliff.toml
index 313ae73..a1d40e8 100644
--- a/cliff.toml
+++ b/cliff.toml
@@ -14,14 +14,14 @@ body = """
 {% 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.scope %}(*{{ commit.scope }}*) {% endif %}\
             {% if commit.breaking %}[**breaking**] {% endif %}\
-            {{ commit.message }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))\
+            {{ commit.message }} ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/adamperkowski/nvrs/commit/{{ commit.id }}){% if commit.remote.username %} by @{{ commit.remote.username }}{%- endif %})\
     {% endfor %}
 {% endfor %}\n
 """
 footer = """
-<!-- generated by git-cliff :) -->
+<sub>generated by [git-cliff](https://github.com/orhun/git-cliff) :)</sub>
 """
 trim = true
 postprocessors = [
@@ -39,7 +39,8 @@ filter_unconventional = false
 split_commits = false
 commit_preprocessors = [
   # Replace issue numbers
-  #{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},
+  { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/adamperkowski/nvrs/issues/${2}))"},
+  { pattern = '\n', replace = "<br>" }
   # 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 -' },
@@ -62,7 +63,7 @@ commit_parsers = [
   { body = ".*", group = "Other (unconventional)" },
 ]
 # filter out the commits that are not matched by commit parsers
-filter_commits = false
+filter_commits = true
 # sort the tags topologically
 topo_order = false
 # sort the commits inside sections by oldest/newest order