cliff.toml

# git-cliff configuration for changelog generation
# See: 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 scope, scoped_commits in commits | group_by(attribute="scope") %}
{% if scope %}**{{ scope }}**
{% endif %}\
{% for commit in scoped_commits %}
- {{ commit.message | upper_first }} ([`{{ commit.id | truncate(length=7, end="") }}`](https://github.com/citum/citum-core/commit/{{ commit.id }}))
{% endfor %}
{% endfor %}
{% endfor %}
"""
trim = true

[git]
conventional_commits = true
# Normalize stale scope names from before the project rename
commit_preprocessors = [
  # processor → engine (renamed during 0.7.0 cycle)
  { pattern = "^([a-z]+)\\(processor\\)", replace = "$1(engine)" },
  # csln → engine (old project name for the processor crate)
  { pattern = "^([a-z]+)\\(csln\\)", replace = "$1(engine)" },
  # processing → engine (transitional scope name)
  { pattern = "^([a-z]+)\\(processing\\)", replace = "$1(engine)" },
  # render/rendering → engine (old scope for the rendering subsystem)
  { pattern = "^([a-z]+)\\(rendering?\\)", replace = "$1(engine)" },
  { pattern = "^([a-z]+)\\(render,inferrer\\)", replace = "$1(engine)" },
  # style → styles (singular/plural inconsistency)
  { pattern = "^([a-z]+)\\(style\\):", replace = "$1(styles):" },
  # testing → tests (singular/plural inconsistency)
  { pattern = "^([a-z]+)\\(testing\\)", replace = "$1(tests)" },
]
filter_unconventional = true
split_commits = false
commit_parsers = [
  { message = "^feat", group = "Features" },
  { message = "^fix", group = "Bug Fixes" },
  { message = "^perf", group = "Performance" },
  { message = "^refactor", group = "Refactor" },
  # Skip internal/low-signal doc scopes
  { message = "^docs?\\(beans\\)", skip = true },
  { message = "^docs?\\(claude\\)", skip = true },
  { message = "^docs?\\(testing\\)", skip = true },
  { message = "^docs?\\(web\\)", skip = true },
  { message = "^docs?\\(compat\\)", skip = true },
  { message = "^docs?\\(site\\)", skip = true },
  { message = "^docs?\\(status\\)", skip = true },
  { message = "^docs?\\(branding\\)", skip = true },
  { message = "^docs?\\(readme\\)", skip = true },
  { message = "^docs?\\(migration\\)", skip = true },
  { message = "^docs?\\(workflow\\)", skip = true },
  { message = "^docs?\\(styleauthor\\)", skip = true },
  { message = "^docs?\\(index\\)", skip = true },
  { message = "^docs?\\(citum\\)", skip = true },
  { message = "^docs?\\(arch\\b", skip = true },
  { message = "^doc", group = "Documentation" },
  { message = "^style", group = "Styling" },
  { message = "^test", group = "Testing" },
  # Skip all chore commits (no Miscellaneous Tasks section)
  { message = "^chore", skip = true },
  # Skip CI, revert, and other low-signal commit types
  { message = "^ci", skip = true },
  { message = "^revert", skip = true },
  { message = "^beans", skip = true },
  { message = "^core", skip = true },
  { message = "^examples?", skip = true },
  { message = "^agent", skip = true },
  { body = ".*security", group = "Security" },
]
protect_breaking_commits = false
filter_commits = false
tag_pattern = "^v[0-9]+\\.[0-9]+\\.[0-9]+$"
skip_tags = ""
ignore_tags = ""
topo_order = false
sort_commits = "oldest"