如何写好Change Log(Commit Log)---分享

最新推荐文章于 2024-08-24 09:10:53 发布
最新推荐文章于 2024-08-24 09:10:53 发布
阅读量2.7k 收藏 5
点赞数 2
分类专栏： 技术方案 文章标签： git commit log
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/nikyae/article/details/111415672
版权

1.背景
当今软件开发往往是一个协作项目，需要多人参与。当项目步入正轨后，后续的开发人员经常需要提交一些代码去增加新的功能（feature）或者修复Bug。随着项目不断往后进行开发迭代，内容也会不断变化，我们对于项目里面的改动逐渐淡忘，这时候就需要项目保持更新日志（Change Log）来协调大家处于同一个步伐。
2.现状
目前很多公司开发项目都没有遵循一个很好的规范，不同开发人员开发完一部分项目后提交代码，往往会按照自己的风格定义自己的commit message，提交比较随意如下图这样，让人难以理解。当代码出现Bug时，也不清楚要回滚到哪个版本。
图1图2
对此，有相关组织提出要标注化提交commit message的方案。其中Keep a Change Log[1] 和 AngularJS[2]都使用了各自的规范，其中AngularJS的规范是由谷歌推出的一套消息规范提交标准，是目前使用最为广泛的写法。因此本次分享着重介绍AngularJS的消息提交规范。使用AngularJS的提交规范后commit消息如下图所示。
图3
3.目标

a. 在浏览的时候可以提供更好的历史信息

如通过下面这条命令可以显示上次发布后的变动，只看每次commit的行首就可以知道提交目的
git log HEAD --pretty=format:%s
在这里插入图片描述

b. 允许通过命令过滤掉某些提交信息

git log HEAD --grep feat ----查看新增加的功能:
在这里插入图片描述
git log HEAD --grep fix ----查看修复的bug:
在这里插入图片描述

c.允许通过脚本自动生成日志

在这里插入图片描述

4.提交信息（commit message）的格式

<type>(<scope>): <subject>     ---Header部分
<BLANK LINE>                 ---空一行
<body>
<BLANK LINE>                 ---空一行
<footer>

<type>(必填):

• feat: 添加新特性
• fix: 修复bug
• docs: 仅仅修改了文档
• style: 仅仅修改了空格、格式缩进、都好等等，不改变代码逻辑
• refactor: 代码重构，没有加新功能或者修复bug
• test: 增加测试用例
• chore: 改变构建流程，或者增加依赖库、工具等
• revert: 回滚到上一个版本

<scope>(可选):

所修改工程的范围，可以自行指定（当没用合适的范围时用*表示）。

<subject>(必填):

一条简短的标题，突出提交的内容，英文用一般现在时，首字母不大写，末尾不要标点。

<body>(可选)

描述具体的修改内容，英文用一般现在时，如

  • 修改内容1
  • 修改内容2
  • 修改内容3

<footer>(可选)

适用于两种情况:
a. 不兼容变动

如果当前代码与上一个版本不兼容，则 Footer 部分以BREAKING CHANGE开头，后面是对变动的描述、以及变动理由和迁移方法。

BREAKING CHANGE: isolate scope bindings definition has changed.

To migrate the code follow the example below:

Before:

scope: {
  myAttr: 'attribute',
}

After:

scope: {
  myAttr: '@',
}

The removed `inject` wasn't generaly useful for directives so there should be no code using it.

b. 关闭Issue

如：

Closes#123

或：

Closes #123, #234, #345

<BLANK LINE>
空一行

注：
1.为了避免阅读的时候遇到换行的情况，每行一般不超过100个字符；
2.Revert：还有一种特殊情况，如果当前 commit 用于撤销以前的 commit，则必须以revert:开头，后面跟着被撤销 Commit 的 Header。

revert: feat(pencil): add 'graphiteWidth' option

This reverts commit 667ecc1654a317a13331b17617d973392f415f02.

Body部分的格式是固定的，必须写成This reverts commit <hash>.，其中的hash是被撤销 commit 的 SHA 标识符。

5.使用工具
5.1 Commitizen（ https://github.com/commitizen/cz-cli ）
Mac电脑需要先安装npm，

$ brew install npm
$ npm install -g commitizen
$ commitizen init cz-conventional-changelog --save-dev --save-exact

使用git cz 代替 git commit
在这里插入图片描述
在这里插入图片描述

5.2 validate-commit-msg( https://github.com/conventional-changelog-archived-repos/validate-commit-msg )

校验格式工具，安装命令

$ npm install --save-dev validate-commit-msg

可以通过编辑文件来配置校验规则
在这里插入图片描述

5.3 conventional-changelog（ https://github.com/conventional-changelog/conventional-changelog ）
运行命令

$ npm install -g conventional-changelog-cli

$ cd my-project

$ conventional-changelog -p angular -i CHANGELOG.md -s -r 0

自动生成日志

在这里插入图片描述

5.4 IDEA插件 Git Commit Template
在这里插入图片描述
在这里插入图片描述
6.总结：
在这里插入图片描述

[1] https://keepachangelog.com/
[2] https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.uyo6cb12dt6w

文太橙子
关注
专栏目录
Changelog：记录变更并编写的有效工具
VcuOcaml的博客
09-17 781
编写一个清晰、易读的Changelog是至关重要的，它能够帮助团队成员和用户更好地理解软件的变更和进展。移除或弃用的功能：如果该版本中有一些被移除或弃用的功能，应该在这个部分进行说明，并给出相应的解释或替代方案。按版本号编写：每个版本的Changelog应该独立编写，以便用户和团队成员能够追踪和比较不同版本之间的变更。版本号和发布日期：每个版本的Changelog应该包含版本号和发布日期，这样用户可以追踪软件的演变。详细描述：尽可能提供详细的描述，包括新增功能的用途、改进的具体细节和修复的问题描述。
【GIT】git-commit Angular规范--- 编辑中
小鱼菜鸟的博客
12-17 318
目录 1、背景 2、Angular规范 3、实例 4、某个博主采用的commit规范 5、提交模板 1、背景 目标 按照一定的规范写commit messages，可以在git push 代码之前(工具/脚本自动)检测commit messages。规范提交信息。 规范提交信息的目的： 生成 CHANGELOG.md识别不重要...
3. 什么是 Changelog 以及如何编写？
我的博客，不一样的自我表达
05-10 1899
但是，如果您和您的同事投入很多，并且可能同时在同一个项目中工作，那么您可能会失去正确的轨道。我们可以看到每个更新的一个 bloc，其中包含更新的日期、更新者的名称以及他们做了什么（在一行中和/或每个更新文件的详细信息）。在这里我们可以看到为项目创建的每个版本，以及添加、更改或删除内容的详细信息，以及每个类别中完成的内容。如果你想为你的项目或你的企业建立一个特定的标准，你可以！与此相关的是，我们可以添加更多信息，例如哪张票与其链接的更新相关…保留更新日志是一种新方式，它是您可以在开源项目中找到的主要标准。
如何使用 keep-a-changelog: 开源变更日志管理指南
最新发布
gitblog_00285的博客
08-24 679
如何使用 keep-a-changelog: 开源变更日志管理指南 keep-a-changelogIf you build software, keep a changelog.项目地址:https://gitcode.com/gh_mirrors/ke/keep-a-changelog 项目介绍 Keep a Changelog 是一个旨在推广并标准化开源项目中 changelog 编写的项...
Change Log应该怎么写？
weixin_34034261的博客
07-11 1735
2019独角兽企业重金招聘Python工程师标准>>> ...
Commit message 和 Change log 编写指南
云满笔记
06-06 469
Commit message 和 Change log 编写指南
change log
weixin_30892037的博客
01-10 178
1、 npm install -g conventional-changelog-cli2、 npm install -g commitizen 3、git cz 替换 git commit 4、执行yarn changelog 就可以生成CHANGELOG.MD 文件 参考文章：https://www.jianshu.com/p/00c9ec4e552e 转载于:htt...
Change Log 前世今生
twomeyla博客
08-14 8733
再说Change Log之前，我们有必要了解它的母体ODS（BI 7 之后称为DSO）。从外界看来，ODS就像一个普通的Table，而我们常常访问ODS也是通过读取他的Active Data Table来获取ODS的数据。因为我们单纯只是了解Data在ODS中的存放结构，所以不会去探讨ODS的其他特性。       上面我们提到了一个Active Data Table，事实上ODS
gitmoji-changelog：gitmoji的变更日志生成器
01-30
使用 commits约定为存储库生成changelog。 :rocket: 用法 请确保您已安装（ npx默认情况下，由于NPM运5.2.0 ） 在项目的根目录运行以下命令并回答问题。 gitmoji-changelog使用来处理不同类型的项目。 默认使用的...
传统的changelog-angular-emoji：Emojis用于带有表情符号的Angular Commit指南
02-05
npm install --save-dev conventional-changelog-angular-emoji 用纱安装 yarn add --dev conventional-changelog-angular-emoji 更新信息： 将提交约定从更新为 。 添加：构建，ci 预习： 壮举（xxx）： :...
generate-changelog:从git commit生成变更日志
05-09
$ npm i generate-changelog -D # install it as a dev dependency # OR $ npm i generate-changelog -g # install it globally 用法 要使用此模块，您的提交消息必须采用以下格式： type(category): description ...
changelog:读取和写入变更日志
05-17
变更日志 解析类似markdown的更改日志（如我们的示例），解析出版本，部分，更改和参考。 动机：自动更新变更日志 与命令捆绑在一起的changelogger 。 changelogger命令 安装 $ go get github.com/parkr/changelog/changelogger 用法 $ $GOPATH/bin/changelogger $ $GOPATH/bin/changelogger -h changelog包 安装 $ go get github.com/parkr/changelog 用法 // Parse changelog at a given filename changes, err := changelog.NewChangelogFromFile("CHANGELOG.md") // Discover the filename of you
github-changelog-generator：从GitHub上的标签，问题，标签和拉取请求自动生成变更日志
02-03
github-changelog-generator 更改日志的生成从未如此简单 全自动的变更日志生成-该gem根据标签，问题和合并的拉取请求（并根据标签将它们拆分为单独的列表）生成一个变更日志文件 GitHub问题追踪器。 由于您现在不必手动填写CHANGELOG.md ：只需运行脚本，放松一下，然后喝一杯 :hot_beverage: 在下一个版本发布之前！ :party_popper: 变更日志的意义何在？ 为了使用户和贡献者更容易准确地看到项目的每个发行版（或版本）之间进行了哪些显着更改。 我为什么要在乎？ 因为软件工具是针对人的。 “变更日志使用户和贡献者更容易准确地看到项目的每个发行版（或版本）之间进行了哪些显着更改。” :right_arrow: 安装 GitHub Changelog Generator是一个程序，以RubyGem的形式分发。 Ruby语言主页上有一个。 像这样安装gem： $ gem install github_changelog_generator 根据您的系统，您可能需要以管理员身份（Windows）运行Shell，或使用sud
jira-changelog:通过将git commit与Jira票证相匹配来生成变更日志
04-30
$ jira-changelog --range origin/prod...origin/master Jira Tickets --------------------- * <Bug> - Unable to access date widget [DEV-1234] https://yoursite.atlassian.net/browse/DEV-1234 * <Story> -...
changelog-sn:定制化changelog工具
05-26
log -- 自动生成 CHANGELOG.md 日志文件 lint -- 校验 commit 信息 依赖安装 npm install changelog --save-dev 配置commitlint和commitizen 代码仓库根目录创建文件.commitlintrc.js和.czconfigrc.js 配置....
change log 的概念
JavaLive09的专栏
05-01 1476
产品： 每次发版，版本间
Change Log - 更改日志
wy的专栏
03-24 3276
查找方法: ST05 - SQL 跟踪 - 找到  INSERT  *  ---(TABLE : VBMOD )
Linux下使用git-cliff生产CHANGELOG.md
xupeng1644的博客
10-16 1192
git-cliff 是一个高度可定制的更新日志生成器，遵循常规的 Commit 规范。git-cliff 可以通过利用传统的 commits 以及由 regex 驱动的自定义解析器，从 Git 历史中生成更新日志文件。更新日志模板可以用配置文件定制，以符合所需的格式。
hudi changelog
12-23
Hudi changelog 是一个记录了 Hudi（Hadoop Upsert/Delete/Insert） 版本更新内容和修复 bug 的文档。它包括了 Hudi 在每个版本中新增的特性、改进和修复的 bug。通过阅读 Hudi changelog，用户可以了解 Hudi 的最新动态和发行版本的变化，以便及时更新自己的应用程序和系统，以确保其与最新的 Hudi 版本保持兼容性。Hudi changelog 还可以让开发人员更好地了解 Hudi 的发展方向和改进重点，为他们在使用 Hudi 进行大数据处理时提供更好的参考和指导。总之，Hudi changelog 是 Hudi 用户了解和跟踪 Hudi 最新版本更新的重要途径，能够帮助用户更好地利用 Hudi 提高大数据处理的效率和性能。
评论 1
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值