use cocogitto cliff config to properly show commit url

CHANGELOG.md

@@ -1,35 +1,44 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.
 
-## [unreleased]
+---
+## [0.1.2](https://github.com/tyrchen/qdrant-lib/compare/v0.1.1..v0.1.2) - 2023-12-17
 
 ### Features
 
-- spawn a new task for message processing for maximum concurrency ([44a9834](44a98340e7f8755959a9d581d8c37a2c691aac7f))
+- spawn a new task for message processing for maximum concurrency - ([f8cfd94](https://github.com/tyrchen/qdrant-lib/commit/f8cfd949a1302177f8f47b804d17a557ca4e4a46)) - Tyr Chen
 
+### Other
+
+- Merge pull request #1 from WSL0809/master
+
+Update README.md - ([32caa14](https://github.com/tyrchen/qdrant-lib/commit/32caa14199fbeb8193b764440356a26389624510)) - Tyr Chen
+- use cocogitto cliff config to properly show commit url - ([e5e714d](https://github.com/tyrchen/qdrant-lib/commit/e5e714de04d98ec6eb393a032cbb870f89061187)) - Tyr Chen
+
+---
 ## [0.1.1] - 2023-12-16
 
 ### Bug Fixes
 
-- fix pthread invalid argument issue. It is causd by qdrant is not terminated properly ([95c5774](95c5774895340672003a80909b5f0073dd1e21ad))
-- fix CI ([ceef0f0](ceef0f0c2f8004937bc01335ca20a1dc9bf7f408))
-- fix CI and prepare for release ([ad53b23](ad53b23a3a718751530c578b3304d1f3b2f94f8e))
+- fix pthread invalid argument issue. It is causd by qdrant is not terminated properly - ([95c5774](https://github.com/tyrchen/qdrant-lib/commit/95c5774895340672003a80909b5f0073dd1e21ad)) - Tyr Chen
+- fix CI - ([ceef0f0](https://github.com/tyrchen/qdrant-lib/commit/ceef0f0c2f8004937bc01335ca20a1dc9bf7f408)) - Tyr Chen
+- fix CI and prepare for release - ([ad53b23](https://github.com/tyrchen/qdrant-lib/commit/ad53b23a3a718751530c578b3304d1f3b2f94f8e)) - Tyr Chen
 
-### Miscellaneous Tasks
+### Miscellaneous Chores
 
-- improve CI to generate changelog upon new git tag ([f860688](f860688cbb08394a027b43d04de526aee1b50b76))
+- improve CI to generate changelog upon new git tag - ([f860688](https://github.com/tyrchen/qdrant-lib/commit/f860688cbb08394a027b43d04de526aee1b50b76)) - Tyr Chen
 
 ### Other
 
-- init the project. Provide very basic functionalities. ([0dd9de8](0dd9de825c0062323374de78b509b79fc81c315c))
-- prepare for git repo ([765c8aa](765c8aabe4c86055ebd1ae20671f963807ec679e))
-- use thiserror for better error handling ([efd6559](efd6559d793dfc8c4f7cf9193ac837ff61eb2f6e))
-- add the rest of the APIs and provide indexer/searcher examples ([9ab234d](9ab234dd4d25a57ed3f9142065c14848212206fb))
-- remove qdrant/qdrant ([156d360](156d360d48261f69af0fb3ff4a6310f748511f8e))
-- remove actix-web-validator from lib/collection in tyrchen/qdrant. It brings in lots of actix dependencies which are not necessary ([9bd6877](9bd68771f1f82aa805b9bafbb3ad3e38ac0a9097))
-- update readme ([6e8aa8f](6e8aa8f3c0217ced2eb927bc9ffc18db89047cc8))
-- add get points API and update CI & readme ([963d2e2](963d2e2b118346cf80a304c1c803172bf6a5cc45))
-- small doc update ([cfe2e1b](cfe2e1bcb744267f2dc98e6368b791db20c7dad4))
+- init the project. Provide very basic functionalities. - ([0dd9de8](https://github.com/tyrchen/qdrant-lib/commit/0dd9de825c0062323374de78b509b79fc81c315c)) - Tyr Chen
+- prepare for git repo - ([765c8aa](https://github.com/tyrchen/qdrant-lib/commit/765c8aabe4c86055ebd1ae20671f963807ec679e)) - Tyr Chen
+- use thiserror for better error handling - ([efd6559](https://github.com/tyrchen/qdrant-lib/commit/efd6559d793dfc8c4f7cf9193ac837ff61eb2f6e)) - Tyr Chen
+- add the rest of the APIs and provide indexer/searcher examples - ([9ab234d](https://github.com/tyrchen/qdrant-lib/commit/9ab234dd4d25a57ed3f9142065c14848212206fb)) - Tyr Chen
+- remove qdrant/qdrant - ([156d360](https://github.com/tyrchen/qdrant-lib/commit/156d360d48261f69af0fb3ff4a6310f748511f8e)) - Tyr Chen
+- remove actix-web-validator from lib/collection in tyrchen/qdrant. It brings in lots of actix dependencies which are not necessary - ([9bd6877](https://github.com/tyrchen/qdrant-lib/commit/9bd68771f1f82aa805b9bafbb3ad3e38ac0a9097)) - Tyr Chen
+- update readme - ([6e8aa8f](https://github.com/tyrchen/qdrant-lib/commit/6e8aa8f3c0217ced2eb927bc9ffc18db89047cc8)) - Tyr Chen
+- add get points API and update CI & readme - ([963d2e2](https://github.com/tyrchen/qdrant-lib/commit/963d2e2b118346cf80a304c1c803172bf6a5cc45)) - Tyr Chen
+- small doc update - ([cfe2e1b](https://github.com/tyrchen/qdrant-lib/commit/cfe2e1bcb744267f2dc98e6368b791db20c7dad4)) - Tyr Chen
 
 <!-- generated by git-cliff -->

cliff.toml

@@ -5,21 +5,37 @@
 # changelog header
 header = """
 # Changelog\n
-All notable changes to this project will be documented in this file.\n
+All notable changes to this project will be documented in this file. See [conventional commits](https://www.conventionalcommits.org/) for commit guidelines.\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") }}
+    {% if previous.version %}\
+        ## [{{ version | trim_start_matches(pat="v") }}]($REPO/compare/{{ previous.version }}..{{ version }}) - {{ timestamp | date(format="%Y-%m-%d") }}
+    {% else %}\
+        ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
+    {% endif %}\
 {% else %}\
     ## [unreleased]
 {% endif %}\
 {% for group, commits in commits | group_by(attribute="group") %}
-    ### {{ group | upper_first }}
-    {% for commit in commits %}
-        - {{ commit.message | trim }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))\
-    {% endfor %}
+    ### {{ group | striptags | trim | upper_first }}
+    {% for commit in commits
+    | filter(attribute="scope")
+    | sort(attribute="scope") %}
+        - **({{commit.scope}})**{% if commit.breaking %} [**breaking**]{% endif %} \
+            {{ commit.message|trim }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }}
+    {%- endfor -%}
+    {% raw %}\n{% endraw %}\
+    {%- for commit in commits %}
+        {%- if commit.scope -%}
+        {% else -%}
+            - {% if commit.breaking %} [**breaking**]{% endif %}\
+                {{ commit.message|trim }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }})) - {{ commit.author.name }}
+        {% endif -%}
+    {% endfor -%}
 {% endfor %}\n
 """
 # template for the changelog footer
@@ -28,7 +44,10 @@ footer = """
 """
 # remove the leading and trailing whitespace from the templates
 trim = true
-
+# postprocessors
+postprocessors = [
+  { pattern = '\$REPO', replace = "https://github.com/tyrchen/qdrant-lib" }, # replace repository URL
+]
 
 [git]
 # parse the commits based on https://www.conventionalcommits.org
@@ -37,18 +56,24 @@ conventional_commits = true
 filter_unconventional = false
 # process each line of a commit as an individual commit
 split_commits = false
+# regex for preprocessing the commit messages
+commit_preprocessors = [
+  # { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers
+]
 # regex for parsing and grouping commits
 commit_parsers = [
   { message = "\\[skip", skip = true },
+  { message = "\\p{Han}", skip = true },
   { message = "^feat", group = "Features" },
   { message = "^fix", group = "Bug Fixes" },
   { message = "^doc", group = "Documentation" },
   { message = "^perf", group = "Performance" },
-  { message = "^refactor", group = "Refactor" },
-  { message = "^style", group = "Styling" },
-  { message = "^test", group = "Testing" },
-  { message = "^chore\\(release\\): prepare for", skip = true },
-  { message = "^chore", group = "Miscellaneous Tasks" },
+  { message = "^refactor", group = "Refactoring" },
+  { message = "^style", group = "Style" },
+  { message = "^revert", group = "Revert" },
+  { message = "^test", group = "Tests" },
+  { message = "^chore\\(version\\):", skip = true },
+  { message = "^chore", group = "Miscellaneous Chores" },
   { message = ".*", group = "Other" },
   { body = ".*security", group = "Security" },
 ]
@@ -66,3 +91,5 @@ ignore_tags = ""
 topo_order = false
 # sort the commits inside sections by oldest/newest order
 sort_commits = "oldest"
+# limit the number of commits included in the changelog.
+# limit_commits = 42