mirror of
https://github.com/orhun/git-cliff.git
synced 2024-12-15 15:22:36 +03:00
8a18e4d48d
* Fix default regexes and references in docs * correction: I didn't realize the colon was necessary * change more tomls, fmt * rebase fixes
60 lines
1.9 KiB
TOML
60 lines
1.9 KiB
TOML
# configuration file for git-cliff (0.1.0)
|
|
|
|
[changelog]
|
|
# changelog header
|
|
header = """
|
|
# Changelog
|
|
All notable changes to this project will be documented in this file.\n
|
|
"""
|
|
# 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 %}\
|
|
{% if previous %}\
|
|
{% if previous.commit_id %}
|
|
[{{ previous.commit_id | truncate(length=7, end="") }}]({{ previous.commit_id }})...\
|
|
[{{ commit_id | truncate(length=7, end="") }}]({{ commit_id }})
|
|
{% endif %}\
|
|
{% endif %}\
|
|
{% for group, commits in commits | group_by(attribute="group") %}
|
|
### {{ group | upper_first }}
|
|
{% for commit in commits %}
|
|
- {{ commit.message | upper_first }} ([{{ commit.id | truncate(length=7, end="") }}]({{ commit.id }}))\
|
|
{% endfor %}
|
|
{% endfor %}\n
|
|
"""
|
|
# remove the leading and trailing whitespaces from the template
|
|
trim = true
|
|
# changelog footer
|
|
footer = """
|
|
<!-- generated by git-cliff -->
|
|
"""
|
|
|
|
[git]
|
|
# allow only conventional commits
|
|
# https://www.conventionalcommits.org
|
|
conventional_commits = true
|
|
# regex for parsing and grouping commits
|
|
commit_parsers = [
|
|
{ message = "^feat", group = "Features"},
|
|
{ message = "^fix", group = "Bug Fixes"},
|
|
{ message = "^doc", group = "Documentation"},
|
|
{ message = "^perf", group = "Performance"},
|
|
{ message = "^refactor", group = "Refactor"},
|
|
{ message = "^style", group = "Styling"},
|
|
{ message = "^test", group = "Testing"},
|
|
{ message = "^chore\\(release\\): prepare for", 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-beta.1"
|