# git-cliff ~ default configuration file

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

#

# Lines starting with "#" are comments.

# Configuration options are organized into tables and keys.

# See documentation for more information on available options.

[changelog]

# template for the changelog header

header = """

# Changelog\n

"""

# template for the changelog body

# https://keats.github.io/tera/docs/#introduction

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

"""

# template for the changelog footer

footer = """

<!-- generated by git-cliff -->

"""

# remove the leading and trailing s

trim = true

# postprocessors

postprocessors = [

# { pattern = '<REPO>', replace = "https://github.com/orhun/git-cliff" }, # replace repository URL

]

# render body even when there are no releases to process

# render_always = true

# output file path

# output = "test.md"

[git]

# parse the commits based on https://www.conventionalcommits.org

conventional_commits = true

# filter out the commits that are not conventional

filter_unconventional = true

# process each line of a commit as an individual commit

split_commits = false

# regex for preprocessing the commit messages

commit_preprocessors = [

# Replace issue numbers

#{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))"},

# Check spelling of the commit with https://github.com/crate-ci/typos

# If the spelling is incorrect, it will be automatically fixed.

#{ pattern = '.*', replace_command = 'typos --write-changes -' },

]

# regex for parsing and grouping commits

commit_parsers = [

{ message = "^feat", group = "<!-- 0 -->🚀 Features" },

{ message = "^fix", group = "<!-- 1 -->🐛 Bug Fixes" },

{ message = "^doc", group = "<!-- 3 -->📚 Documentation" },

{ message = "^perf", group = "<!-- 4 -->⚡ Performance" },

{ message = "^refactor", group = "<!-- 2 -->🚜 Refactor" },

{ message = "^style", group = "<!-- 5 -->🎨 Styling" },

{ message = "^test", group = "<!-- 6 -->🧪 Testing" },

{ message = "^chore\\(release\\): prepare for", skip = true },

{ message = "^chore\\(deps.*\\)", skip = true },

{ message = "^chore\\(pr\\)", skip = true },

{ message = "^chore\\(pull\\)", skip = true },

{ message = "^chore|^ci", group = "<!-- 7 -->⚙️ Miscellaneous Tasks" },

{ body = ".*security", group = "<!-- 8 -->🛡️ Security" },

{ message = "^revert", group = "<!-- 9 -->◀️ Revert" },

]

# filter out the commits that are not matched by commit parsers

filter_commits = false

# sort the tags topologically

topo_order = false

# sort the commits inside sections by oldest/newest order

sort_commits = "oldest"