113 lines
4.4 KiB
TOML
113 lines
4.4 KiB
TOML
# git-cliff ~ configuration file
|
|
# https://git-cliff.org/docs/configuration
|
|
|
|
|
|
[changelog]
|
|
# A Tera template to be rendered as the changelog's footer.
|
|
# See https://keats.github.io/tera/docs/#introduction
|
|
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).
|
|
|
|
## [Unreleased]
|
|
"""
|
|
# A Tera template to be rendered for each release in the changelog.
|
|
# See https://keats.github.io/tera/docs/#introduction
|
|
body = """
|
|
|
|
{%- if version %}
|
|
## [{{ version }}]\
|
|
{%- if previous.version == version -%}\
|
|
(<REPO>/releases/tag/{{ version }})\
|
|
{%- else -%}\
|
|
(<REPO>/compare/{{ previous.version }}...{{ version }})\
|
|
{% endif %} \
|
|
- {{ timestamp | date(format="%Y-%m-%d") }}
|
|
{% for group, commits in commits | group_by(attribute="group") %}
|
|
### {{ group | upper_first }}
|
|
|
|
{% for commit in commits %}
|
|
{%- if commit.scope -%}
|
|
- *({{commit.scope}})* {% if commit.breaking %}[**breaking**] {% endif %}\
|
|
{{ commit.message }}\
|
|
{%- if commit.links %} \
|
|
({% for link in commit.links %}[{{link.text}}]({{link.href}}) {% endfor -%})\
|
|
{% endif %}
|
|
{% else -%}
|
|
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message }}
|
|
{% endif -%}
|
|
{% endfor -%}
|
|
{% endfor %}\
|
|
{%- else -%}
|
|
{% endif -%}
|
|
"""
|
|
# A Tera template to be rendered as the changelog's footer.
|
|
# See https://keats.github.io/tera/docs/#introduction
|
|
footer = ""
|
|
# Remove leading and trailing whitespaces from the changelog's body.
|
|
trim = true
|
|
# Render body even when there are no releases to process.
|
|
render_always = true
|
|
# An array of regex based postprocessors to modify the changelog.
|
|
postprocessors = [
|
|
# Replace the placeholder <REPO> with a URL.
|
|
{ pattern = '<REPO>', replace = "https://github.com/tauri-apps/cef-rs" },
|
|
{ pattern = '\[[\w\-]+-v([0-9.+]+)\]', replace = "[${1}]" },
|
|
]
|
|
# render body even when there are no releases to process
|
|
# render_always = true
|
|
# output file path
|
|
# output = "test.md"
|
|
|
|
[git]
|
|
# Parse commits according to the conventional commits specification.
|
|
# See https://www.conventionalcommits.org
|
|
conventional_commits = true
|
|
# Exclude commits that do not match the conventional commits specification.
|
|
filter_unconventional = true
|
|
# Require all commits to be conventional.
|
|
# Takes precedence over filter_unconventional.
|
|
require_conventional = false
|
|
# Split commits on newlines, treating each line as an individual commit.
|
|
split_commits = false
|
|
# An array of regex based parsers to modify commit messages prior to further processing.
|
|
commit_preprocessors = [
|
|
# Replace issue numbers with link templates to be updated in `changelog.postprocessors`.
|
|
{ pattern = '(\w+\s)?#([0-9]+)', replace = "${1}[#${2}](<REPO>/issues/${2})" },
|
|
{ pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](<REPO>/issues/${2}))" },
|
|
# Check spelling of the commit message using https://github.com/crate-ci/typos.
|
|
# If the spelling is incorrect, it will be fixed automatically.
|
|
#{ pattern = '.*', replace_command = 'typos --write-changes -' },
|
|
]
|
|
# Prevent commits that are breaking from being excluded by commit parsers.
|
|
protect_breaking_commits = false
|
|
# An array of regex based parsers for extracting data from the commit message.
|
|
# Assigns commits to groups.
|
|
# Optionally sets the commit's scope and can decide to exclude commits from further processing.
|
|
commit_parsers = [
|
|
{ message = "^feat", group = "added" },
|
|
{ message = "^changed", group = "changed" },
|
|
{ message = "^deprecated", group = "deprecated" },
|
|
{ message = "^fix", group = "fixed" },
|
|
{ message = "^security", group = "security" },
|
|
{ message = "^.*", group = "other" },
|
|
]
|
|
# Exclude commits that are not matched by any commit parser.
|
|
filter_commits = false
|
|
# An array of link parsers for extracting external references, and turning them into URLs, using regex.
|
|
link_parsers = []
|
|
# Include only the tags that belong to the current branch.
|
|
use_branch_tags = false
|
|
# Order releases topologically instead of chronologically.
|
|
topo_order = false
|
|
# Order releases topologically instead of chronologically.
|
|
topo_order_commits = true
|
|
# Order of commits in each group/release within the changelog.
|
|
# Allowed values: newest, oldest
|
|
sort_commits = "newest"
|
|
# Process submodules commits
|
|
recurse_submodules = false
|