dreamstack/cliff.toml

67 lines
2.2 KiB
TOML
Raw Normal View History

# git-cliff configuration for DreamStack
# https://git-cliff.org/docs/configuration
#
# Per-package changelogs:
# git-cliff --include-path "compiler/ds-parser/**" -o compiler/ds-parser/CHANGELOG.md
# git-cliff --include-path "engine/ds-stream/**" -o engine/ds-stream/CHANGELOG.md
#
# Full workspace changelog:
# git-cliff -o CHANGELOG.md
[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 %}\n
"""
footer = """
<!-- generated by git-cliff -->
"""
trim = true
[git]
conventional_commits = true
filter_unconventional = true
split_commits = false
commit_preprocessors = [
# Truncate overly long commit messages to keep the changelog scannable
{ pattern = "^(.{0,120}).*$", replace = "$1" },
]
commit_parsers = [
{ message = "^feat", group = "<!-- 0 -->🚀 Features" },
{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },
{ message = "^refactor", group = "<!-- 2 -->🔧 Refactoring" },
{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },
{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },
{ message = "^improve", group = "<!-- 0 -->🚀 Features" },
{ message = "^refine", group = "<!-- 2 -->🔧 Refactoring" },
{ message = "^style", group = "<!-- 5 -->🎨 Styling" },
{ message = "^test", group = "<!-- 6 -->🧪 Testing" },
{ message = "^chore\\(release\\)", skip = true },
{ message = "^chore\\(deps\\)", skip = true },
{ message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous" },
{ body = ".*security", group = "<!-- 8 -->🔒 Security" },
]
protect_breaking_commits = false
filter_commits = false
topo_order = false
sort_commits = "oldest"
tag_pattern = "v[0-9].*"