Manuel Raimann
100 lines
3.4 KiB
TOML
100 lines
3.4 KiB
TOML
# git-cliff configuration
|
|
# https://git-cliff.org/docs/configuration
|
|
|
|
[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.1.0/),
|
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).\n
|
|
"""
|
|
# template for the changelog body
|
|
# https://keats.github.io/tera/docs/#introduction
|
|
body = """
|
|
{%- macro remote_url() -%}
|
|
https://github.com/raimannma/rust-optimizer
|
|
{%- endmacro -%}
|
|
|
|
{% 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 | striptags | trim }}
|
|
{% for commit in commits %}
|
|
- {{ commit.message | split(pat="\n") | first | trim }}\
|
|
{%- if commit.breaking %} (**BREAKING**){% endif -%}
|
|
{% endfor %}
|
|
{% endfor %}
|
|
"""
|
|
# template for the changelog footer
|
|
footer = """
|
|
{%- macro remote_url() -%}
|
|
https://github.com/raimannma/rust-optimizer
|
|
{%- endmacro -%}
|
|
|
|
{% for release in releases -%}
|
|
{% if release.version -%}
|
|
{% if release.previous.version -%}
|
|
[{{ release.version | trim_start_matches(pat="v") }}]: \
|
|
{{ self::remote_url() }}/compare/{{ release.previous.version }}...{{ release.version }}
|
|
{% else -%}
|
|
[{{ release.version | trim_start_matches(pat="v") }}]: \
|
|
{{ self::remote_url() }}/releases/tag/{{ release.version }}
|
|
{% endif -%}
|
|
{% else -%}
|
|
{% if release.previous.version -%}
|
|
[Unreleased]: {{ self::remote_url() }}/compare/{{ release.previous.version }}...HEAD
|
|
{% endif -%}
|
|
{% endif -%}
|
|
{% endfor %}
|
|
"""
|
|
# remove the leading and trailing whitespace from the templates
|
|
trim = true
|
|
|
|
[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/raimannma/rust-optimizer/issues/${2}))" },
|
|
]
|
|
# regex for parsing and grouping commits
|
|
commit_parsers = [
|
|
{ message = "^feat", group = "Added" },
|
|
{ message = "^fix", group = "Fixed" },
|
|
{ message = "^refactor", group = "Changed" },
|
|
{ message = "^perf", group = "Changed" },
|
|
{ message = "^doc", group = "Changed" },
|
|
{ message = "^style", group = "Changed" },
|
|
{ message = "^ci", skip = true },
|
|
{ message = "^chore\\(release\\)", skip = true },
|
|
{ message = "^chore: release", skip = true },
|
|
{ message = "^chore", group = "Changed" },
|
|
{ message = "^revert", group = "Removed" },
|
|
{ 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
|
|
# regex for matching git tags
|
|
tag_pattern = "v[0-9].*"
|
|
# regex for skipping tags
|
|
skip_tags = ""
|
|
# regex for ignoring tags
|
|
ignore_tags = ""
|
|
# sort the tags topologically
|
|
topo_order = false
|
|
# sort the commits inside sections by oldest first
|
|
sort_commits = "oldest"
|