Skip to content

ci: generate release notes with git-cliff#282

Merged
innomentats merged 1 commit into
mainfrom
chore/git-cliff-release-notes
Jul 14, 2026
Merged

ci: generate release notes with git-cliff#282
innomentats merged 1 commit into
mainfrom
chore/git-cliff-release-notes

Conversation

@eetoc

@eetoc eetoc commented Jul 14, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • Generate Release Notes with git-cliff for v* tags.
  • Keep runtime and historical client release lines out via tag_pattern.
  • Replace the fixed Release body with the generated release-notes.md.

Validation

  • Local git-cliff 2.13.1 offline generation passed.
  • Workflow YAML parsing passed.
  • git diff --check passed.

Notes

  • Existing installer assets and idempotent upload behavior remain unchanged.
  • The release job has pull-requests: read permission for PR metadata.

@monkeyscan

monkeyscan Bot commented Jul 14, 2026

Copy link
Copy Markdown

PR Title: ci: generate release notes with git-cliff

Commit: 9f342af

本次变更引入了 git-cliff 自动生成 Release Notes 的功能,包含两部分:

  1. 新增 cliff.toml 配置文件,定义了 conventional commits 解析规则、标签匹配模式 ^v[0-9].* 以及 GitHub 远程仓库信息。
  2. 修改 .github/workflows/images.ymlrelease job:添加 fetch-depth: 0 以获取完整 Git 历史,集成 orhun/git-cliff-action@v4 生成 release-notes.md,并将 gh release create--notes 参数替换为 --notes-file release-notes.md

整体评估:变更简洁合理,使用官方 git-cliff-action,权限控制良好(job 级别 pull-requests: read + contents: write),无明显的正确性、安全或可靠性风险。

@eetoc
eetoc marked this pull request as ready for review July 14, 2026 04:28
@innomentats
innomentats merged commit 1caf5be into main Jul 14, 2026
10 checks passed
@innomentats
innomentats deleted the chore/git-cliff-release-notes branch July 14, 2026 06:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants