mirror of
https://github.com/chatmail/core.git
synced 2026-04-02 05:22:14 +03:00
85de4bf678
Some commit messages start with the function names for additional context and these should not be capitalized.
94 lines
3.2 KiB
TOML
94 lines
3.2 KiB
TOML
# configuration file for git-cliff
|
|
# see https://git-cliff.org/docs/configuration/
|
|
|
|
|
|
[git]
|
|
# parse the commits based on https://www.conventionalcommits.org
|
|
conventional_commits = true
|
|
# filter out the commits that are not conventional
|
|
filter_unconventional = false
|
|
# process each line of a commit as an individual commit
|
|
split_commits = false
|
|
# regex for preprocessing the commit messages
|
|
commit_preprocessors = [
|
|
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/chatmail/core/pull/${2}))"}, # replace pull request / issue numbers
|
|
]
|
|
# regex for parsing and grouping commits
|
|
commit_parsers = [
|
|
{ message = "^feat", group = "Features / Changes"},
|
|
{ message = "^fix", group = "Fixes"},
|
|
{ message = "^api", group = "API-Changes" },
|
|
{ message = "^refactor", group = "Refactor"},
|
|
{ message = "^perf", group = "Performance"},
|
|
{ message = "^test", group = "Tests"},
|
|
{ message = "^style", group = "Styling"},
|
|
{ message = "^chore\\(release\\): prepare for", skip = true},
|
|
{ message = "^chore", group = "Miscellaneous Tasks"},
|
|
{ message = "^build", group = "Build system"},
|
|
{ message = "^docs", group = "Documentation"},
|
|
{ message = "^ci", group = "CI"},
|
|
{ message = ".*", group = "Other"},
|
|
# { body = ".*security", group = "Security"},
|
|
]
|
|
# protect breaking changes from being skipped due to matching a skipping commit_parser
|
|
protect_breaking_commits = true
|
|
# 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"
|
|
# regex for ignoring tags
|
|
ignore_tags = ""
|
|
# sort the tags topologically
|
|
topo_order = false
|
|
# sort the commits inside sections by oldest/newest order
|
|
sort_commits = "oldest"
|
|
# limit the number of commits included in the changelog.
|
|
# limit_commits = 42
|
|
|
|
|
|
[changelog]
|
|
# changelog header
|
|
header = """
|
|
# Changelog\n
|
|
"""
|
|
# template for the changelog body
|
|
# https://keats.github.io/tera/docs/#templates
|
|
body = """
|
|
{% if version %}\
|
|
## [{{ version | trim_start_matches(pat="v") }}] - {{ 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 %}
|
|
- {% if commit.breaking %}[**breaking**] {% endif %}\
|
|
{% if commit.scope %}{{ commit.scope }}: {% endif %}\
|
|
{{ commit.message }}.\
|
|
{% if commit.footers is defined %}\
|
|
{% for footer in commit.footers %}{% if 'BREAKING CHANGE' in footer.token %}
|
|
{% raw %} {% endraw %}- {{ footer.value }}\
|
|
{% endif %}{% endfor %}\
|
|
{% endif%}\
|
|
{% endfor %}
|
|
{% endfor %}\n
|
|
"""
|
|
# remove the leading and trailing whitespace from the template
|
|
trim = true
|
|
footer = """
|
|
{% for release in releases -%}
|
|
{% if release.version -%}
|
|
{% if release.previous.version -%}
|
|
[{{ release.version | trim_start_matches(pat="v") }}]: \
|
|
https://github.com/chatmail/core\
|
|
/compare/{{ release.previous.version }}..{{ release.version }}
|
|
{% endif -%}
|
|
{% else -%}
|
|
[unreleased]: https://github.com/chatmail/core\
|
|
/compare/{{ release.previous.version }}..HEAD
|
|
{% endif -%}
|
|
{% endfor %}
|
|
"""
|