cliff.toml

# https://git-cliff.org/docs/configuration
[changelog]
header = ""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{% if version %}\
## New Version [{{ version | trim_start_matches(pat="v") }}]
{% 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 }} ({% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\
            {% if commit.github.pr_number %} in #{{ commit.github.pr_number }}{%- endif %})
    {% endfor %}
{% endfor %}\n
"""
footer = """
{% for release in releases -%}
    {% if release.version %}\
        ## [{{ release.version | trim_start_matches(pat="v") }}]
    {% 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 }} ({% if commit.github.username %} by @{{ commit.github.username }}{%- endif %}\
                {% if commit.github.pr_number %} in #{{ commit.github.pr_number }}{%- endif %})
        {% endfor %}
    {% endfor %}\n
{% endfor %}
"""
trim = true

[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = true
# filter out the commits that are not conventional
filter_unconventional = true
split_commits = false
# sort the commits inside sections by oldest/newest order
sort_commits = "newest"
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" },
]