You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
53 lines
1.6 KiB
53 lines
1.6 KiB
# 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 %}\ |
|
{% for group, commits in commits | group_by(attribute="group") %} |
|
### {{ group | upper_first }} |
|
{% for commit in commits %} |
|
- {{ commit.message | upper_first }}\ |
|
{% 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"
|
|
|