cliff.toml

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

[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.0.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 | upper_first }}
    {% for commit in commits
    | filter(attribute="scope")
    | sort(attribute="scope") %}
        - *({{commit.scope}})* {{ commit.message | upper_first }}\
            {%- if commit.breaking %}
        {% raw %}  {% endraw %}- **BREAKING:** {{commit.breaking_description}}
        {%- endif -%}
    {%- endfor -%}
    {% raw %}\n{% endraw %}\
    {%- for commit in commits %}
        {%- if commit.scope -%}
        {% else -%}
            - {{ commit.message | upper_first }}\
            {% if commit.breaking -%}
            {% raw %}  {% endraw %}- **BREAKING:** {{commit.breaking_description}}
            {% endif -%}
        {% endif -%}
    {% endfor -%}
{% endfor %}\n
"""

footer = """
{% if remote.github -%}
    {% for release in releases -%}
        {% if release.version and release.previous and release.previous.version -%}
            [{{ release.version | trim_start_matches(pat="v") }}]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/compare/{{ release.previous.version }}...{{ release.version }}
        {% elif release.version -%}
            [{{ release.version | trim_start_matches(pat="v") }}]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/releases/tag/{{ release.version }}
        {% elif release.previous and release.previous.version -%}
            [unreleased]: https://github.com/{{ remote.github.owner }}/{{ remote.github.repo }}/compare/{{ release.previous.version }}...HEAD
        {% endif -%}
    {% endfor -%}
{% endif -%}

---
*Generated by [git-cliff](https://git-cliff.org)*
"""

trim = true

[git]
conventional_commits = true
filter_unconventional = true
split_commits = false

commit_preprocessors = [{ pattern = '  +', replace = " " }]

commit_parsers = [
  { message = "^feat", group = "Features" },
  { message = "^feature", group = "Features" },
  { message = "^fix", group = "Bug Fixes" },
  { message = "^bugfix", group = "Bug Fixes" },
  { message = "^perf", group = "Performance Improvements" },
  { message = "^security", group = "Security" },
  { message = "^docs", group = "Documentation" },
  { message = "^build", group = "Build System" },
  { message = "^ci", group = "CI/CD" },
  { message = "^refactor", group = "Refactoring" },
  { message = "^test", group = "Testing" },
  { message = "^deps", group = "Dependencies" },
  { message = "^chore\\(deps\\)", group = "Dependencies" },
  { message = "^ci\\(release\\):", skip = true },
  { message = "^release:", skip = true },
  { message = "^chore\\(release\\):", skip = true },
  { message = "^chore", group = "Miscellaneous Tasks" },
  { message = "^revert", group = "Reverts" },
  { message = "^Merge branch", skip = true },
  { message = "^Merge pull request", skip = true },
  { message = "^Merge remote-tracking branch", skip = true },
  { message = "^wip", skip = true },
  { message = "^WIP", skip = true },
  { message = ".*", group = "Other Changes" },
]

protect_breaking_commits = true
filter_commits = false
tag_pattern = "v[0-9].*"
sort_commits = "oldest"

[bump]
features_always_bump_minor = false
breaking_always_bump_major = false
initial_tag = "v0.1.0"
custom_major_increment_regex = "MAJOR|BREAKING[- ]CHANGE"
custom_minor_increment_regex = "feat|feature|MINOR"