cliff.toml

# git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration

[remote.github]
owner = "mr-pmillz"
repo = "eoldate"

[changelog]
# changelog header
header = """
# Changelog\n
All notable changes to this project will be documented [here](https://github.com/mr-pmillz/eoldate/blob/main/CHANGELOG.md?ref_type=heads) \n
"""
# template for the changelog body
# https://keats.github.io/tera/docs/#introduction
body = """
{%- macro remote_url() -%}
  https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}
{%- endmacro -%}

{% macro print_commit(commit) -%}
    - {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
        {% if commit.breaking %}[**breaking**] {% endif %}\
        {{ commit.message | upper_first }} - \
        ([{{ commit.id | truncate(length=7, end="") }}]({{ self::remote_url() }}/commit/{{ commit.id }}))\
{% endmacro -%}

{% if version %}\
    {% if previous.version %}\
        ## [{{ version | trim_start_matches(pat="v") }}]\
          ({{ self::remote_url() }}/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 | striptags | trim | upper_first }}
    {% for commit in commits
    | filter(attribute="scope")
    | sort(attribute="scope") %}
        {{ self::print_commit(commit=commit) }}
    {%- endfor -%}
    {% raw %}\n{% endraw %}\
    {%- for commit in commits %}
        {%- if not commit.scope -%}
            {{ self::print_commit(commit=commit) }}
        {% endif -%}
    {% endfor -%}
{% endfor %}\n
"""
# template for the changelog footer
footer = """
<!-- generated by git-cliff -->
"""
# remove the leading and trailing whitespace from the templates
trim = true
# postprocessors
postprocessors = []

[git]
# parse the commits based on https://www.conventionalcommits.org
conventional_commits = false
# filter out the commits that are not conventional
filter_unconventional = false
# process each line of a commit as an individual commit
split_commits = true
# regex for parsing and grouping commits
commit_parsers = [
    { message = "^.*: add", group = "<!-- 0 -->✨ New features" },
    { message = "^add", group = "<!-- 0 -->✨ New features" },
    { message = "^feat*", group = "<!-- 0 -->✨: New features" },
    { message = "^.* support", group = "<!-- 0 -->✨ New features" },
    { message = "^fix*", group = "<!-- 1 -->🐛 Bug fixes" },
    { message = "^.* resolved", group = "<!-- 1 -->🐛 Bug fixes" },
    { message = "^.*: fix", group = "<!-- 1 -->🐛 Bug fixes" },
    { message = "^refactor*", group = "<!-- 2 -->🚜 Refactor" },
    { message = "^doc", group = "<!-- 3 -->📚 Documentation" },
    { message = "^perf", group = "<!-- 4 -->⚡ Performance" },
    { message = "^optimized", group = "<!-- 4 -->⚡ Performance" },
    { message = "^enhanced", group = "<!-- 4 -->⚡ Performance" },
    { message = "^style", group = "<!-- 5 -->🎨 Styling" },
    { message = "^test*", group = "<!-- 6 -->🧪 Testing" },
    { message = "^deps", group = "<!-- 7 -->📦 Dependencies" },
    { message = "^dependencies", group = "<!-- 7 -->📦 Dependencies" },
    { message = "^dependency", group = "<!-- 7 -->📦 Dependencies" },
    { message = "^update*", group = "<!-- 8 -->🛠 Improvements" },
    { message = "^chore\\(release\\): prepare for", skip = true },
    { message = "^chore\\(deps.*\\)", skip = true },
    { message = "^chore\\(pr\\)", skip = true },
    { message = "^chore\\(pull\\)", skip = true },
    { message = "^.*", group = "<!-- 9 -->⚙️ Miscellaneous" },
    { message = "^chore|^ci", group = "<!-- 10 -->⚙️ Miscellaneous Tasks" },
    { body = ".*security", group = "<!--11 -->🛡️ Security" },
    { message = "^revert", group = "<!-- 12 -->◀️ Revert" },
    { message = "^.*: remove", group = "Removed" },
    { message = "^.*: delete", group = "Removed" },
]
# protect breaking changes from being skipped due to matching a skipping commit_parser
protect_breaking_commits = false
# filter out the commits that are not matched by commit parsers
filter_commits = false
# regex for matching git tags
tag_pattern = "v[0-9].*"

# regex for skipping tags
skip_tags = "beta|alpha"
# regex for ignoring tags
ignore_tags = ""
# sort the tags topologically
topo_order = false
# sort the commits inside sections by oldest/newest order
sort_commits = "newest"