cliff-template.toml

[changelog]
header = """
# Changelog

"""
body = """
{% if version %}\
	# [{{ version | trim_start_matches(pat="v") }}]\
	{% if previous %}\
		{% if previous.version %}\
			(REPOSITORY_URL/compare/{{ previous.version }}...{{ version }})\
		{% else %}\
			(REPOSITORY_URL/tree/{{ version }})\
		{% endif %}\
	{% endif %} \
	- ({{ 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 %}
		- {% if commit.scope %}\
			**{{commit.scope}}:** \
		  {% endif %}\
		  {% if '```' in commit.message %}\
		    {{ commit.message | upper_first }}\n\
		    ([{{ commit.id | truncate(length=7, end="") }}](REPOSITORY_URL/commit/{{ commit.id }}))  - ({{ commit.author.name }})\
          {% else %}\
			{{ commit.message | upper_first  }} ([{{ commit.id | truncate(length=7, end="") }}](REPOSITORY_URL/commit/{{ commit.id }}))  - ({{ commit.author.name }})\
          {% endif %}\
		{% if commit.breaking %}\
			{% for breakingChange in commit.footers %}\
				\n{% raw %}  {% endraw %}- **{{ breakingChange.token }}{{ breakingChange.separator }}** {{ breakingChange.value }}\
			{% endfor %}\
		{% endif %}\
	{% endfor %}
{% endfor %}\n
"""
trim = true

[git]
conventional_commits = true
filter_unconventional = false
protect_breaking_commits = false
commit_preprocessors = [
    { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](REPOSITORY_URL/issues/${2}))"},
    { pattern = "Merge pull request #([0-9]+) from [^ ]+", replace = "PR [#${1}](https://github.com/orhun/git-cliff/pull/${1}):"},
]
commit_parsers = [
    { message = "(?i)^feat", group = "<!-- 0 -->🚀 Features"},
    { message = "(?i)^fix", group = "<!-- 1 -->🐛 Bug Fixes"},
    { message = "(?i)^doc", group = "<!-- 3 -->📚 Documentation"},
    { message = "(?i)^perf", group = "<!-- 4 -->⚡ Performance"},
    { message = "(?i)^refactor", group = "<!-- 2 -->🚜 Refactor"},
    { message = "(?i)^style", group = "<!-- 5 -->🎨 Styling"},
    { message = "(?i)^test", group = "<!-- 6 -->🧪 Testing"},
    { message = "(?i)^chore", group = "<!-- 7 -->⚙️ Miscellaneous Tasks"},
    { body = ".*security", group = "<!-- 8 -->🛡️ Security"},
    { message = "(?i)^upgrade", group = "<!-- 9 -->⬆️ Upgrades"},
    { message = "(?i)^downgrade", group = "<!-- 10 -->⬇️ Downgrades"},
    { message = "(?i)^revert", group = "<!-- 11 -->⏪ Reverts"},
    { message = "(?i)^merge", group = "<!-- 12 -->🔀 Merges"},
    { message = "(?i)^release", group = "<!-- 13 -->🔖 Releases"},
    { message = "(?i)^bump", group = "<!-- 14 -->🔖 Releases"},
    { message = "(?i)^initial", group = "<!-- 15 -->🎉 Initial Commit"},
    { message = "(?i)^init", group = "<!-- 15 -->🎉 Initial Commit"},
    { message = "(?i)^add", group = "<!-- 16 -->➕ Add"},
    { message = "(?i)^create", group = "<!-- 16 -->➕ Add"},
    { message = "(?i)^remove", group = "<!-- 17 -->➖ Remove"},
    { message = "(?i)^delete", group = "<!-- 17 -->➖ Remove"},
    { message = "(?i)^rename", group = "<!-- 18 -->📝 Rename"},
    { message = "(?i)^move", group = "<!-- 19 -->📂 Move"},
    { message = "(?i)^copy", group = "<!-- 20 -->📋 Copy"},
    { message = "(?i)^fixup", group = "<!-- 21 -->🔧 Fixup"},
    { message = "(?i)^wip", group = "<!-- 22 -->🚧 WIP"},
    { message = "(?i)^rework", group = "<!-- 23 -->🔨 Rework"},
    { message = "(?i)^cleanup", group = "<!-- 24 -->🧹 Cleanup"},
    { message = "(?i)^format", group = "<!-- 25 -->🎨 Format"},
    { message = "(?i)^style", group = "<!-- 25 -->🎨 Format"},
    { message = "(?i)^lint", group = "<!-- 25 -->🎨 Format"},
    { message = "(?i)^update", group = "<!-- 26 -->🔄 Update"},
    { message = "(?i)^pin", group = "<!-- 29 -->📌 Pin"},
    { message = "(?i)^unpin", group = "<!-- 30 -->📍 Unpin"},
    { message = "(?i)^build", group = "<!-- 11 -->👷 CI/CD"},
    { message = ".*", group = "<!-- 12 -->📝 Other"},
]
tag_pattern = "v[0-9]*"
topo_order = false
sort_commits = "newest"