chore: modify changelog format (#26)

* chore: modify changelog format

* chore: fix template

Author: beeb

CHANGELOG.md

@@ -6,66 +6,66 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 
-- Add github action (#15) - ([05431f6](https://github.com/beeb/awsbck/commit/05431f6ca93fa59333a927a7ccb0dc6aeb5ccb4a))
-- Add tests (#21) - ([bf7e4fc](https://github.com/beeb/awsbck/commit/bf7e4fc15eff6ca32ea007fde5a0e85351b38d9f))
+- Add github action (#15) - ([05431f6](https://github.com/beeb/lintspec/commit/05431f6ca93fa59333a927a7ccb0dc6aeb5ccb4a))
+- Add tests (#21) - ([bf7e4fc](https://github.com/beeb/lintspec/commit/bf7e4fc15eff6ca32ea007fde5a0e85351b38d9f))
 
 ### Fixed
 
-- Parent ignore files must be enabled (#17) - ([6d9663e](https://github.com/beeb/awsbck/commit/6d9663e68d00a4cbe3a734e71e87a8f140613e90))
-- Return comment should not include return name (#19) - ([8be4150](https://github.com/beeb/awsbck/commit/8be4150d45039a7eda95f135ee4d34eb73bbe0a9))
-- Process functions without returns (#20) - ([7fdfbda](https://github.com/beeb/awsbck/commit/7fdfbda4856eeb94ac29cca9cb4cd6b2332842d5))
+- Parent ignore files must be enabled (#17) - ([6d9663e](https://github.com/beeb/lintspec/commit/6d9663e68d00a4cbe3a734e71e87a8f140613e90))
+- Return comment should not include return name (#19) - ([8be4150](https://github.com/beeb/lintspec/commit/8be4150d45039a7eda95f135ee4d34eb73bbe0a9))
+- Process functions without returns (#20) - ([7fdfbda](https://github.com/beeb/lintspec/commit/7fdfbda4856eeb94ac29cca9cb4cd6b2332842d5))
 
 ## [0.1.5] - 2025-02-20
 
 ### Fixed
 
-- Output a line return after json output (#12) - ([89f616f](https://github.com/beeb/awsbck/commit/89f616ff029229ecc49a89ea443e0dfe9bdebcb7))
-- Merging of config from CLI and config file (#14) - ([bbef59a](https://github.com/beeb/awsbck/commit/bbef59ad3d68031d0258dca8ad47d11edc9c229d))
+- Output a line return after json output (#12) - ([89f616f](https://github.com/beeb/lintspec/commit/89f616ff029229ecc49a89ea443e0dfe9bdebcb7))
+- Merging of config from CLI and config file (#14) - ([bbef59a](https://github.com/beeb/lintspec/commit/bbef59ad3d68031d0258dca8ad47d11edc9c229d))
 
 ## [0.1.4] - 2025-02-20
 
 ### Documentation
 
-- Fix help text (#9) - ([6f3025e](https://github.com/beeb/awsbck/commit/6f3025e95fc2f377ac5a7d66f157584ac9040125))
-- Update readme (#11) - ([a123795](https://github.com/beeb/awsbck/commit/a12379584155c2822168962d7f64ed7af8f03048))
+- Fix help text (#9) - ([6f3025e](https://github.com/beeb/lintspec/commit/6f3025e95fc2f377ac5a7d66f157584ac9040125))
+- Update readme (#11) - ([a123795](https://github.com/beeb/lintspec/commit/a12379584155c2822168962d7f64ed7af8f03048))
 
 ## [0.1.3] - 2025-02-20
 
 ### Added
 
-- Add icon to title (#6) - ([0c0f300](https://github.com/beeb/awsbck/commit/0c0f300b717771832e6d41ae0c9a1149e70b54cb))
-- Add cargo-dist (#7) - ([fe9a65e](https://github.com/beeb/awsbck/commit/fe9a65e81b37a5b50ec8c2db2cc1dbac4b03d5e3))
+- Add icon to title (#6) - ([0c0f300](https://github.com/beeb/lintspec/commit/0c0f300b717771832e6d41ae0c9a1149e70b54cb))
+- Add cargo-dist (#7) - ([fe9a65e](https://github.com/beeb/lintspec/commit/fe9a65e81b37a5b50ec8c2db2cc1dbac4b03d5e3))
 
 ### Changed
 
-- Change phrasing - ([71aa36e](https://github.com/beeb/awsbck/commit/71aa36e0421c5d83380ca41d1fe99857244e8c91))
+- Change phrasing - ([71aa36e](https://github.com/beeb/lintspec/commit/71aa36e0421c5d83380ca41d1fe99857244e8c91))
 
 ### Fixed
 
-- Highlighted span (#8) - ([e53840f](https://github.com/beeb/awsbck/commit/e53840f7614e018569dfc8be18701b9000709d82))
+- Highlighted span (#8) - ([e53840f](https://github.com/beeb/lintspec/commit/e53840f7614e018569dfc8be18701b9000709d82))
 
 ## [0.1.2] - 2025-02-19
 
 ### Added
 
-- Add badges - ([ea6b8a6](https://github.com/beeb/awsbck/commit/ea6b8a61514466ab34ec0343d97d3b20da35da45))
+- Add badges - ([ea6b8a6](https://github.com/beeb/lintspec/commit/ea6b8a61514466ab34ec0343d97d3b20da35da45))
 
 ### Changed
 
-- Update benchmark with comparable output format - ([1b0bc92](https://github.com/beeb/awsbck/commit/1b0bc9291b866921bba35778fd8466459146cef8))
+- Update benchmark with comparable output format - ([1b0bc92](https://github.com/beeb/lintspec/commit/1b0bc9291b866921bba35778fd8466459146cef8))
 
 ### Fixed
 
-- Parsing of the `--out` CLI arg (#3) - ([b0de154](https://github.com/beeb/awsbck/commit/b0de154ed7fca881c737f54d20c80617fff5a9cd))
-- Fix links - ([95d8585](https://github.com/beeb/awsbck/commit/95d85857f729c11ce68740754d6144823ed152e7))
+- Parsing of the `--out` CLI arg (#3) - ([b0de154](https://github.com/beeb/lintspec/commit/b0de154ed7fca881c737f54d20c80617fff5a9cd))
+- Fix links - ([95d8585](https://github.com/beeb/lintspec/commit/95d85857f729c11ce68740754d6144823ed152e7))
 
 ## [0.1.1] - 2025-02-19
 
 ### Added
 
-- Add workflows (#1) - ([e06b444](https://github.com/beeb/awsbck/commit/e06b4449649758565bc6cc5a064fb2117cf96dc1))
+- Add workflows (#1) - ([e06b444](https://github.com/beeb/lintspec/commit/e06b4449649758565bc6cc5a064fb2117cf96dc1))
 
 ### Changed
 
-- Update readme - ([2369db0](https://github.com/beeb/awsbck/commit/2369db044f00813db0685f4e1b38253d87df6c3d))
+- Update readme - ([2369db0](https://github.com/beeb/lintspec/commit/2369db044f00813db0685f4e1b38253d87df6c3d))
 

cliff.toml

@@ -1,7 +1,7 @@
 [changelog]
 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
 """
 
 body = """
@@ -10,10 +10,26 @@ body = """
 {% endif %}\
 {% for group, commits in commits | group_by(attribute="group") %}
     ### {{ group | upper_first }}
-    {% for commit in commits %}
-        - {{ commit.message | upper_first }} - ([{{ commit.id | truncate(length=7, end="") }}](https://github.com/beeb/awsbck/commit/{{ commit.id }}))\
+    {% for commit in commits | filter(attribute="scope") | sort(attribute="scope") %}
+        - **({{commit.scope}})**{% if commit.breaking %} [**breaking**]{% endif %} \
+            {{ commit.message }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }}))
     {% endfor %}
+    {% raw %}\n{% endraw %}\
+    {%- for commit in commits %}
+        {%- if commit.scope -%}
+        {% else -%}
+            - {% if commit.breaking %} [**breaking**]{% endif %}\
+                {{ commit.message }} - ([{{ commit.id | truncate(length=7, end="") }}]($REPO/commit/{{ commit.id }}))
+        {% endif -%}
+    {% endfor -%}
 {% endfor %}\n
+{% if version %}
+    {% if previous.version %}
+      **Full Changelog**: $REPO/compare/{{ previous.version }}...{{ version }}
+    {% endif %}
+{% else -%}
+  {% raw %}\n{% endraw %}
+{% endif %}
 """
 
 # remove the leading and trailing whitespace from the template
@@ -43,7 +59,7 @@ commit_parsers = [
 ] # regex for parsing and grouping commits
 
 # protect breaking changes from being skipped due to matching a skipping commit_parser
-protect_breaking_commits = false
+protect_breaking_commits = true
 # filter out the commits that are not matched by commit parsers
 filter_commits = false
 # glob pattern for matching git tags