cliff.toml

# git-cliff configuration for Release Scribe

[changelog]
header = """
# Changelog

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

"""
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 %}{% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}
{% endfor %}

{% endfor %}
"""
footer = ""
trim = true
render_always = true

[git]
conventional_commits = true
filter_unconventional = true
require_conventional = false
split_commits = false
protect_breaking_commits = false
filter_commits = false
tag_pattern = "^[0-9].*$"
skip_tags = "^beta|^alpha|^v.*"
topo_order = false
topo_order_commits = true
sort_commits = "oldest"
commit_parsers = [
  { message = "^feat", group = "<!-- 0 -->Features" },
  { message = "^fix", group = "<!-- 1 -->Bug Fixes" },
  { message = "^refactor", group = "<!-- 2 -->Refactor" },
  { message = "^doc", group = "<!-- 3 -->Documentation" },
  { message = "^test", group = "<!-- 4 -->Testing" },
  { message = "^chore\\(release\\): version packages", skip = true },
  { message = "^chore\\(release\\): update changelog for", skip = true },
  { message = "^chore", group = "<!-- 5 -->Chore" },
  { message = "^ci", group = "<!-- 6 -->CI" },
  { message = "^revert", group = "<!-- 7 -->Revert" },
  { body = ".*security", group = "<!-- 8 -->Security" },
  { message = ".*", group = "<!-- 9 -->Other" },
]