96 lines
4.3 KiB
TOML
96 lines
4.3 KiB
TOML
|
# git-cliff ~ configuration file
|
||
|
|
# https://git-cliff.org/docs/configuration
|
||
|
|
|
||
|
|
|
||
|
|
[changelog]
|
||
|
|
# A Tera template to be rendered for each release in the changelog.
|
||
|
|
# See https://keats.github.io/tera/docs/#introduction
|
||
|
|
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 | striptags | trim | upper_first }}
|
||
|
|
{% for commit in commits %}
|
||
|
|
- {% if commit.scope %}*({{ commit.scope }})* {% endif %}\
|
||
|
|
{% if commit.breaking %}[**breaking**] {% endif %}\
|
||
|
|
{{ commit.message | upper_first }} ({{commit.id}} by {{commit.author.name}})\
|
||
|
|
{% endfor %}
|
||
|
|
{% endfor %}
|
||
|
|
"""
|
||
|
|
# 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/orhun/git-cliff" },
|
||
|
|
]
|
||
|
|
# 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 = "([#${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 = "^(add|新增|添加)", group = "<!-- 0 -->🚀 新增功能" },
|
||
|
|
{ message = "^(fix|修复)", group = "<!-- 1 -->🐛 修复" },
|
||
|
|
{ message = "^doc", group = "<!-- 5 -->📚 文档更改" },
|
||
|
|
{ message = "^(improve|改进|优化)", group = "<!-- 3 -->⚡ 体验优化" },
|
||
|
|
{ message = "^refactor", group = "<!-- 2 -->🚜 重构" },
|
||
|
|
{ message = "^style", group = "<!-- 6 -->🎨 格式化" },
|
||
|
|
{ message = "^(delete|删除|移除)", group = "<!-- 4 -->❌ 删除功能" },
|
||
|
|
{ message = "^test", group = "<!-- 7 -->🧪 测试" },
|
||
|
|
{ message = "^chore\\(release\\): prepare for", skip = true },
|
||
|
|
{ message = "^chore\\(deps.*\\)", skip = true },
|
||
|
|
{ message = "^chore\\(pr\\)", skip = true },
|
||
|
|
{ message = "^chore\\(pull\\)", skip = true },
|
||
|
|
{ message = "^chore|^ci", group = "<!-- 8 -->⚙️ 杂项" },
|
||
|
|
{ body = ".*security", group = "<!-- 9 -->🛡️ 安全" },
|
||
|
|
{ message = "^revert", group = "<!-- 10 -->◀️ 回退" },
|
||
|
|
{ message = "(版本|version|更新版本号)", group = "<!-- 11 -->🎉 版本号更新" },
|
||
|
|
{ message = ".*", group = "<!-- 12 -->💼 其他更改" },
|
||
|
|
]
|
||
|
|
# 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 = "oldest"
|
||
|
|
# Process submodules commits
|
||
|
|
recurse_submodules = false
|