chore(cliff): update config

This commit is contained in:
steven-omaha
2023-06-06 16:46:13 +02:00
parent d11467a318
commit 23129d9cb2
+22 -18
View File
@@ -1,4 +1,4 @@
# git-cliff ~ default configuration file # git-cliff ~ configuration file
# https://git-cliff.org/docs/configuration # https://git-cliff.org/docs/configuration
# #
# Lines starting with "#" are comments. # Lines starting with "#" are comments.
@@ -8,22 +8,27 @@
[changelog] [changelog]
# changelog header # changelog header
header = """ header = """
# Changelog\n # Changelog
All notable changes to this project will be documented in this file.\n
""" """
# template for the changelog body # template for the changelog body
# https://tera.netlify.app/docs # https://tera.netlify.app/docs/
body = """ 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") %} {% for group, commits in commits | group_by(attribute="group") %}
### {{ group | upper_first }} ### {{ group | striptags | trim | upper_first }}
{% for commit in commits %} {% for commit in commits
- {% if commit.breaking %}[**breaking**] {% endif %}{{ commit.message | upper_first }}\ | filter(attribute="scope")
{% endfor %} | sort(attribute="scope") %}
- {{commit.scope}}:{% if commit.breaking %} [**breaking**]{% endif %} \
{{ commit.message }}
{%- endfor -%}
{% raw %}\n{% endraw %}\
{%- for commit in commits %}
{%- if commit.scope -%}
{% else -%}
-{% if commit.breaking %} [**breaking**]{% endif %} \
{{ commit.message }}
{% endif -%}
{% endfor -%}
{% endfor %}\n {% endfor %}\n
""" """
# remove the leading and trailing whitespace from the template # remove the leading and trailing whitespace from the template
@@ -42,7 +47,7 @@ filter_unconventional = true
split_commits = false split_commits = false
# regex for preprocessing the commit messages # regex for preprocessing the commit messages
commit_preprocessors = [ commit_preprocessors = [
# { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))"}, # replace issue numbers { pattern = '\((\w+\s)?#([0-9]+)\)', replace = "([#${2}](https://github.com/orhun/git-cliff/issues/${2}))" },
] ]
# regex for parsing and grouping commits # regex for parsing and grouping commits
commit_parsers = [ commit_parsers = [
@@ -67,10 +72,9 @@ tag_pattern = "v[0-9]*"
# regex for skipping tags # regex for skipping tags
skip_tags = "v0.1.0-beta.1" skip_tags = "v0.1.0-beta.1"
# regex for ignoring tags # regex for ignoring tags
ignore_tags = "beta" ignore_tags = ""
# sort the tags topologically # sort the tags topologically
topo_order = false topo_order = false
# sort the commits inside sections by oldest/newest order # sort the commits inside sections by oldest/newest order
sort_commits = "oldest" sort_commits = "newest"
# limit the number of commits included in the changelog.
# limit_commits = 42