1
1
mirror of https://github.com/orhun/git-cliff.git synced 2024-12-15 14:51:59 +03:00
git-cliff/cliff.toml

45 lines
1.1 KiB
TOML

# configuration file for git-cliff (0.1.0)
[changelog]
# changelog header
header = """
# Changelog
"""
# template for the changelog body
# https://tera.netlify.app/docs/#introduction
body = """
{% if version %}\
## [{{ version | replace(from="v", to="") }}] - {{ 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 %}
- {{ commit.message | upper_first }}\
{% endfor %}
{% endfor %}
"""
# changelog footer
footer = """
<!-- generated by git-cliff -->
"""
[git]
# allow only conventional commits
conventional_commits = true
# regex for parsing and grouping commits
commit_parsers = [
{ message = "feat*", group = "Features"},
{ message = "fix*", group = "Bug Fixes"},
{ message = "chore: Prepare*", skip = true},
{ message = "chore*", group = "Miscellaneous Tasks"},
{ body = ".*security", group = "Security"},
]
# filter out the commits that are not matched by commit parsers
filter_commits = false
# glob pattern for matching git tags
tag_pattern = "v[0-9]*"
# regex for skipping tags
skip_tags = "v0.1.0"