Git怎么生成更新日志_Git自动生成changelog方法详解【实战】

冬萱姑娘_4512

冬萱姑娘_4512

2026-05-20

793人浏览

原创

真正可用的 changelog 生成路径是 standard-version 配合 conventional commits:需提交严格遵循 feat(api): add timeout option 格式,运行 npx standard-version --release-as 1.4.0 自动生 changelog.md、打 tag、更新版本。

git怎么生成更新日志_git自动生成changelog方法详解【实战】

git log 生成 changelog 的核心命令

直接用 git log 能出日志,但默认格式不适合当 changelog:没有语义化分组、缺少版本锚点、提交信息杂乱。真正可用的起点是带格式化和范围限制的命令。

  • 按版本区间提取(比如从 v1.2.0 到 v1.3.0):git log v1.2.0..v1.3.0 --pretty=format:"* %s (%an)" --reverse
  • 过滤掉合并提交(避免日志里全是 “Merge branch…”):--no-merges 必加
  • 只取 feat/fix/docs 类型的提交(需团队约定前缀):git log --grep="^feat\|^fix\|^docs" -i

conventional-commits + standard-version 是最稳的自动化路径

手动拼 git log 命令容易漏版本、难维护、不兼容 CI。用 standard-version 配合 conventional commits 约定,才能真正“自动生成”——它不是魔法,而是靠规则换确定性。

  • 前提:所有提交必须遵守 feat(api): add timeout option 这类格式,否则 standard-version 无法分类
  • 安装后运行:npx standard-version --release-as 1.4.0,它会自动:生成 CHANGELOG.md、打 tag、更新 package.json 版本
  • CI 中慎用 --skip.tag:跳过打 tag 看似安全,但后续 git log v1.3.0..v1.4.0 就会失效

GitHub/GitLab API 拉取 release 日志的适用场景

如果你没权限改本地提交规范,或项目用的是 GUI 提交(比如 VS Code Git UI),git logstandard-version 都不可行,就得绕路走 API。

Conventional Git
Conventional Git

Conventional Commits v1.0.0 分支、工作树命名及提交信息规范,适用于 GitHub 与 GitLab 项目,用于创建分支和命名工作树等场景。

下载
  • GitHub:curl -H "Accept: application/vnd.github+json" https://api.github.com/repos/{owner}/{repo}/releases,解析 body 字段
  • GitLab:GET /projects/:id/releases,注意要传 private_token,且免费版只返回最近 20 个 release
  • 风险点:API 返回的 changelog 是人填的,可能为空、格式混乱、甚至写“同上一版”,没法做自动化比对

changelog 文件怎么更新才不冲突

多人并行发版时,CHANGELOG.md 极易冲突——因为所有分支都在往同一个文件末尾追加内容。这不是 Git 的问题,是写法问题。

  • 别让每个 PR 都改 CHANGELOG.md:改了也白改,merge 顺序一变,内容就乱
  • 正确做法:只在发版分支(如 release/1.4)上由 standard-version 一次性生成,且禁止手工编辑
  • 如果必须人工补条目(比如修复了没提 PR 的 hotfix),用脚本在指定位置插入,而不是 append——否则 git blame 失效,diff 也看不出谁改了哪行

实际跑通的关键不在工具链多炫,而在提交信息有没有被当回事。没人写 fix(ui): prevent null ref in dropdown,再好的 standard-version 也吐不出像样的 changelog。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

git

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

2549

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2088

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1060

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

998

4

c语言random函数用法
c语言random函数用法

c语言random函数用法:1、random.random,随机生成(0,1)之间的浮点数;2、random.randint,随机生成在范围之内的整数,两个参数分别表示上限和下限;3、random.randrange,在指定范围内,按指定基数递增的集合中获得一个随机数;4、random.choice,从序列中随机抽选一个数;5、random.shuffle,随机排序。

2023.09.05

1236

5

c语言const用法
c语言const用法

const是关键字,可以用于声明常量、函数参数中的const修饰符、const修饰函数返回值、const修饰指针。详细介绍:1、声明常量,const关键字可用于声明常量,常量的值在程序运行期间不可修改,常量可以是基本数据类型,如整数、浮点数、字符等,也可是自定义的数据类型;2、函数参数中的const修饰符,const关键字可用于函数的参数中,表示该参数在函数内部不可修改等等。

2023.09.20

1878

7

c语言get函数的用法
c语言get函数的用法

get函数是一个用于从输入流中获取字符的函数。可以从键盘、文件或其他输入设备中读取字符,并将其存储在指定的变量中。本文介绍了get函数的用法以及一些相关的注意事项。希望这篇文章能够帮助你更好地理解和使用get函数 。

2023.09.20

2860

8

c数组初始化的方法
c数组初始化的方法

c语言数组初始化的方法有直接赋值法、不完全初始化法、省略数组长度法和二维数组初始化法。详细介绍:1、直接赋值法,这种方法可以直接将数组的值进行初始化;2、不完全初始化法,。这种方法可以在一定程度上节省内存空间;3、省略数组长度法,这种方法可以让编译器自动计算数组的长度;4、二维数组初始化法等等。

2023.09.22

12235

6

c语言中null和NULL的区别
c语言中null和NULL的区别

c语言中null和NULL的区别是:null是C语言中的一个宏定义,通常用来表示一个空指针,可以用于初始化指针变量,或者在条件语句中判断指针是否为空;NULL是C语言中的一个预定义常量,通常用来表示一个空值,用于表示一个空的指针、空的指针数组或者空的结构体指针。

2023.09.22

509

3

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
vscode手册
vscode手册

共0课时 | 0人学习

Git 教程
Git 教程

共21课时 | 7.8万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.8万人学习