cliff.toml

# git-cliff configuration for automated changelog generation
# https://git-cliff.org
#
# Requires conventional commits: https://www.conventionalcommits.org/
#
# Install: cargo install git-cliff
# Usage: git-cliff --unreleased --prepend CHANGELOG.md

[changelog]
header = """
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

"""
body = """
{% if version %}\
    ## [{{ version | trim_start_matches(pat="v") }}] - {{ timestamp | date(format="%Y-%m-%d") }}
{% 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 %}\
            {{ commit.message | upper_first }}\
            {% if commit.github.pr_number %} ([#{{ commit.github.pr_number }}](https://github.com/bitsongofficial/go-bitsong/pull/{{ commit.github.pr_number }})){% endif %}\
    {% endfor %}
{% endfor %}\n
"""
footer = """
<!-- generated by git-cliff -->
"""
trim = true
postprocessors = []

[git]
conventional_commits = true
filter_unconventional = true
split_commits = false
commit_preprocessors = []
commit_parsers = [
    { message = "^security", group = "<!-- 0 -->Security" },
    { message = "^feat", group = "<!-- 1 -->Features" },
    { message = "^fix", group = "<!-- 2 -->Bug Fixes" },
    { message = "^perf", group = "<!-- 3 -->Performance" },
    { message = "^refactor", group = "<!-- 4 -->Refactor" },
    { message = "^doc", group = "<!-- 5 -->Documentation" },
    { message = "^deps", group = "<!-- 6 -->Dependencies" },
    { message = "^chore\\(deps\\)", group = "<!-- 6 -->Dependencies" },
    { message = "^chore|^ci", group = "<!-- 7 -->Miscellaneous", skip = true },
    { message = "^test", group = "<!-- 8 -->Testing", skip = true },
    { body = ".*security.*", group = "<!-- 0 -->Security" },
    { body = "BREAKING CHANGE", group = "<!-- 0 -->Breaking Changes" },
]
protect_breaking_commits = true
filter_commits = false
topo_order = false
sort_commits = "oldest"