sanshu/cliff.toml at main · yuaotian/sanshu · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
# git-cliff 配置文件
# 用于生成结构化的 changelog

[changelog]
# changelog 头部
header = ""

# changelog 主体模板 - 清晰的结构化格式
body = """
## What's Changed

{% for group, commits in commits | group_by(attribute="group") %}
### {{ group }}

{% for commit in commits -%}
* {{ commit.message | split(pat=":") | last | trim | upper_first }} by [@{{ commit.author.name }}](https://github.com/{{ commit.author.name }}) in [{{ commit.id | truncate(length=7, end="") }}](https://github.com/yuaotian/sanshu/commit/{{ commit.id }})
{% endfor %}
{% endfor -%}
"""

# changelog 尾部
footer = ""

# 去除多余空行
trim = true

[git]
# 解析常规提交格式
conventional_commits = true
# 过滤非常规提交
filter_unconventional = false
# 分割提交信息
split_commits = false
# 提交解析器
commit_parsers = [
  { message = "^feat", group = "✨ 新功能" },
  { message = "^fix", group = "🐞 修复" },
  { message = "^perf", group = "💎 优化" },
  { message = "^refactor", group = "♻️ 重构" },
  { message = "^docs?", group = "📚 文档" },
  { message = "^style", group = "💄 样式" },
  { message = "^test", group = "🧪 测试" },
  { message = "^build", group = "📦 构建" },
  { message = "^security", group = "🔒 安全" },
  { message = "^chore\\(release\\)", skip = true },
  { message = "^chore\\(deps", skip = true },
  { message = "^chore|^ci", group = "🔧 维护" },
  { message = "^revert", group = "⏪ 回滚" },
  { message = ".*", group = "📝 其他" },
]

# 提交预处理器 - 清理提交信息
commit_preprocessors = [
  # 移除 issue 编号
  { pattern = ' #\d+$', replace = "" },
  # 移除多余空格
  { pattern = '\s+', replace = " " },
  # 清理 merge commit 格式
  { pattern = '^Merge pull request #\d+ from [^\s]+', replace = "" },
  { pattern = '^Merge branch ', replace = "" },
]

# 链接解析器 - 自动识别 issue 和 PR 链接
link_parsers = [
  { pattern = "#(\\d+)", href = "https://github.com/yuaotian/sanshu/issues/$1" },
  { pattern = "\\[([^\\]]+)\\]\\(([^)]+)\\)", text = "$1", href = "$2" },
]

# 保护分支
protect_breaking_commits = false
# 过滤提交
filter_commits = false
# 标签模式
tag_pattern = "v[0-9].*"
# 跳过标签
skip_tags = "v0.1.0-beta.1"
# 忽略标签
ignore_tags = ""
# 排序方式
topo_order = false
# 排序提交 - 最新的在前
sort_commits = "newest"

[remote.github]
owner = "yuaotian"
repo = "sanshu"