mirror of
https://github.com/orhun/git-cliff.git
synced 2025-01-05 23:15:53 +03:00
49 lines
1.2 KiB
TOML
49 lines
1.2 KiB
TOML
[changelog]
|
|
# changelog header
|
|
header = """
|
|
# Changelog
|
|
|
|
All notable changes to this project will be documented in this file.
|
|
|
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
"""
|
|
|
|
# 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 | capitalize}}
|
|
{% for commit in commits %}
|
|
- {{ commit.message | capitalize_first }}\
|
|
{% endfor %}
|
|
{% endfor %}
|
|
"""
|
|
|
|
# changelog footer
|
|
footer = """
|
|
<!-- generated by git-cliff -->
|
|
"""
|
|
|
|
# regex for parsing and grouping commits
|
|
commit_parsers = [
|
|
{ regex = "feat*", group = "Features"},
|
|
{ regex = "fix*", group = "Bug Fixes"},
|
|
{ regex = "chore: Prepare*", skip = true},
|
|
{ regex = "chore*", group = "Miscellaneous Tasks"},
|
|
]
|
|
|
|
# filter out the commits that are not matched by commit parsers
|
|
filter_group = false
|
|
|
|
# glob pattern for matching git tags
|
|
git_tag_pattern = "v[0-9]*"
|
|
|
|
# regex for skipping tags
|
|
skip_tags_regex = "v0.1.0"
|