1
1
mirror of https://github.com/orhun/git-cliff.git synced 2024-12-15 15:41:46 +03:00
git-cliff/examples/keepachangelog.toml
Steven L 8a18e4d48d
fix(config): fix default regexes and references in docs (#7)
* Fix default regexes and references in docs

* correction: I didn't realize the colon was necessary

* change more tomls, fmt

* rebase fixes
2021-09-08 21:40:29 +03:00

55 lines
1.7 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.
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).\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 = "^.*: add", group = "Added"},
{ message = "^.*: support", group = "Added"},
{ message = "^.*: remove", group = "Removed"},
{ message = "^.*: delete", group = "Removed"},
{ message = "^test", group = "Fixed"},
{ message = "^fix", group = "Fixed"},
{ message = "^.*: fix", group = "Fixed"},
{ message = "^.*", group = "Changed"},
]
# filter out the commits that are not matched by commit parsers
filter_commits = true
# glob pattern for matching git tags
tag_pattern = "v[0-9]*"
# regex for skipping tags
skip_tags = "v0.1.0-beta.1"