利用shell脚本生成CHANGELOG.md（包含git提交规范）

最新推荐文章于 2024-12-19 09:57:14 发布
最新推荐文章于 2024-12-19 09:57:14 发布
阅读量766 收藏 1
点赞数 1
CC 4.0 BY-SA版权
文章标签： shell git
原文链接：http://www.cnblogs.com/linkstar/p/10274943.html
本文介绍如何通过遵循特定的Git提交规范，利用shell脚本自动生成项目的Changelog.md文件，展示版本更新信息。文章提供了规范示例及脚本链接，适用于mac或linux环境。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

前言

我们经常看到github上面有很多CHANGELOG.MD包含版本的更新信息，如果我们的git提交能遵循一定的规范，那么使用gitlog就能很方便的生成它

 

生成结果



 

shell脚本

https://github.com/LinkinStars/springBootTemplate/blob/master/gitlog.sh

将脚本放在项目的根目录，然后给与权限，然后运行后，就能生成和上面差不多的CHANGELOG.md

 

git提交规范

当然如果你和上面不一样也正常，需要你git提交的message按照一定的规范，如下：

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>

- type：用于说明commit的类别，规定为如下几种
-- feat (增加新功能)
-- fix (修改bug)
-- docs (文档修改)
-- style (代码格式修改)
-- refactor (重构并且不影响任何功能)
-- test (测试代码修改)
-- chore (维护相关杂项)

- scope：【可选】用于说明commit的影响范围
- subject：commit的简要说明，一句话描述这次的改动，尽量简短
- body
更新的具体细节

具体实例就和上面的图片中所示
这个规范是google上面来的，需要***
https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#heading=h.greljkmo14y0

相关还有：http://www.ruanyifeng.com/blog/2016/01/commit_message_change_log.html

里面也有相应的工具可以生成，但是我觉得还是shell脚本好用，因为对于mac或者linux不需要任何环境依赖

 

PS:脚本很简单，你可以根据你的实际情况进行调整输出的格式数据等

 

转载于:https://www.cnblogs.com/linkstar/p/10274943.html

git工程化 自动生成changeLog 发布版本
qq_35425070的博客
06-21 8072
git log 生成 changeLog 在进行git仓库的自动化管理时，发布前往往需要CI服务器自动生成 CHANGELOG.MD ，本文介绍如何自动changeLog.md自动生成的思路。 生成流程 多次 commit -m “xxx” 使用命令 git log > log 生成提交记录 log 文件 处理 log 文件提取关心的信息, 然后转成 CHANGELOG.MD 文件. 思路：（log文件中包含了所有的commit信息, 包括id, author, date以及comment等） 前
shell ：基本格式.md
m0_55778885的博客
03-22 1305
shell Shell又称命令解释器，它能识别用户输入的各种命令，并传递给操作系统 Shell既是用户交互的界面，也是控制系统的脚本语言 shell的分类 Bourne Shell：标识为sh，该Shell由Steve Bourne在贝尔实验室时编写。在许多Unix系统中，该Shell是root用户的默认的Shell。 Bourne-Again Shell：标识为bash，该Shell由Brian Fox在1987年编写，是绝大多数localhost发行版的默认的Shell。 Korn She
gitchangelog, 从git日志历史记录创建日志记录.zip
09-18
gitchangelog, 从git日志历史记录创建日志记录 gitchangelog 使用提交日志来创建beautifull和可以配置日志文件文件。特性完全由一个配置文件驱动，可以用你的变更日志策略进行定制。 ( 参见参考配置文件 )根据正则表达式匹配筛选出提交/标
shell脚本自动生成changelog
zzbazinga的博客
10-10 540
shell脚本自动生成changelog #!/bin/bash ## Author LinkinStar # solve the space by IFS IFS=$(echo -en "\n\b") echo -en $IFS if [ -f "CHANGELOG.md" ]; then rm -f CHANGELOG.md touch CHANGELOG.md else touch CHANGELOG.md fi function printFeat() { for i in $
Git 规范和 Changelog 生成
liixnhai的博客
08-17 2449
1、良好的 Git commit 规范优势： ·加快 Code Review 的流程 ·根据 Git Commit 的元数据生成 Changelog ·后续维护者可以知道 Feature 被修改的原因 2、提交时类型选择提示，commitize 不符合格式的日志拒绝提交的保障机制，validate-commit-msg工具+客户端、 gitlab serverhook做统一changelog 文档信息生成，使用conventional-changelog-cli工具 3、angular的g
Git Changelog 项目使用指南
gitblog_00549的博客
12-19 513
Git Changelog 项目使用指南 项目简介和编程语言 Git Changelog 是一个用于自动生成变更日志的工具，它利用Jinja2模板来提供对生成过程的完全控制。通过分析git日志，它能够根据提交信息生成格式化的变更日志文件。该项目适用于想要自动化版本更新记录的开发者，支持多种提交样式和约定，并提供内置的模板。 该项目的编程语言主要是Python，因为其主要的运行和安装依赖于Pytho...
如何写好Change Log(Commit Log)---分享
nikyae的博客
12-21 3415
1.背景 当今软件开发往往是一个协作项目，需要多人参与。当项目步入正轨后，后续的开发人员经常需要提交一些代码去增加新的功能（feature）或者修复Bug。随着项目不断往后进行开发迭代，内容也会不断变化，我们对于项目里面的改动逐渐淡忘，这时候就需要项目保持更新日志（Change Log）来协调大家处于同一个步伐。 2.现状 目前很多公司开发项目都没有遵循一个很好的规范，不同开发人员开发完一部分项目后提交代码，往往会按照自己的风格定义自己的commit message，提交比较随意，像图1，图2这样，让人难以
release.sh脚本：利用CHANGELOG.md自动化版本管理
3. **提交 CHANGELOG.md**：在版本准备好发布后，脚本会提交CHANGELOG.md文件。 4. **打标签**：脚本会在当前提交处使用从标题中找到的版本号来对git仓库进行标记。 5. **更新版本号**：将版本号中的预发布后缀写回...
如何创建和更新 changelog.md 文件？
最新发布
08-05
引用[3]则提到了使用shell脚本生成CHANGELOG.md，并给出了commit的规范（包括type、scope、subject、body等）。 因此，我们可以将回答分为两个主要部分： 1. 手动创建和更新 changelog.md 2. 自动化创建和更新 ...
py-changelogmd：Python模块和CLI工具管理CHANGELOG.md
### 知识点一：CHANGELOG.md文件的作用 CHANGELOG.md 文件是一个通常用于开源项目中的文档，用以记录项目版本的更新历史。它详细地列出了每个版本的发布日期、版本号以及与该版本相关的所有更改。这些更改可能包括...
changelog-for-git:一种基于Git历史记录创建变更日志的简单方法
05-20
Git Changelog生成器 使用一个命令，生成整个提交历史记录的漂亮.html文件。 这是提醒您以前工作的好方法，并且为客户和/或同事提供了绝佳的视觉效果。 变更日志示例 设置 确保您正在至少提交一次的git存储库中工作。 我建议为您的git-changelog.sh文件创建一个别名，以便您可以通过在每个项目文件夹中使用诸如changelog类的命令来调用它。 要在计算机上创建别名，只需将以下行添加到位于OSX上/User/username/.bash_profile的.bash_profile中。 alias changelog='sh ~/Dropbox/Files/git-changelog.sh' （可选）在每次提交时自动构建新的变更日志 将提交后的文件放置在project-directory / .git / hooks /中，并编辑源路径以在每次提交后立即运行git
changelog:解析变更日志文件
07-05
变更日志 将帮助您找出版本之间的变化的工具。 里面有什么？ 解析变更日志文件 (CHANGELOG.md, CHANGED) 有什么可做的？ 从 github 版本中获取变更日志 从 github 获取变更日志 - 如果有变更日志文件 - 解析它，如果没有 - 从发布中获取 上面的api
CHANGELOG.md
04-29
CHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.mdCHANGELOG.md
Changelog.sh：提高变更日志管理效率的git工具
【标签】:"git bash Shell"这个标签表明，Changelog.sh工具是基于Git版本控制系统设计的，并且可能包含一个Bash脚本文件，供开发者在命令行界面中使用。开发者通常需要在本地的Shell环境下运行这些脚本，来自动化...
Git Changelog生成器：快速创建变更日志的工具
文档中提到的脚本是 `git-changelog.sh`，这个脚本可能已经包含在压缩包子文件 `changelog-for-git-master` 中。如果你想要手动编写一个类似的功能，那么你需要熟悉 Shell 脚本编程以及如何与 Git 命令行接口进行...
vue 根据git commit记录生成CHANGELOG.md文档
好巧的博客
10-20 1621
当然，如果你觉得文章有什么让你觉得不合理、或者有更简单的实现方法又或者有理解不来的地方，希望你在看到之后能够在评论里指出来，我会在看到之后尽快的回复你。生成 CHANGELOG.md 需要符合 git commit 提交规范，规范配置请查看另一篇文章。-n ./.changelog.config.js: 自定义配置文件。1.根目录新建 .changelog.config.js。-i CHANGELOG.md：指定输出的文件名称。-r 0：指定增量更新，不会覆盖以前的更新。-s：指定读写同一文件。
还在用git commit -m 吗？Git 提交规范和自动产生changelog手摸手教程。
星宇大前端
01-12 1825
前言 我们在使用一个比较厉害的框架或者库的时候，经常可以看到CHANGELOG.md，维护版本更新内容。 比如vue-next： 这种版本更新内容是非常必要的，如果用户使用了你的轮子，连更新内容都不知道，试问你敢用吗？ 那么这些都是怎么写的呢？每次发版都要手动记录吗？显然不是，这些都是靠提条记录生成的。下面一起他探索一下吧。   正文 生成这种CHANGELOG 有一个前提，就是团队成员都按规矩提交。 人不是机器，习惯不养成往往会忽略，这种约束还是工具来吧。 一、安装 commitizen
git log 获取构建时间_如何生成changelog：自从上次Hudson构建以来,git log？
weixin_42527654的博客
01-15 262
@ takehin的答案是正确的,如果您有权访问build.xml文件,但这可能会中断,特别是如果您在从属节点上构建(因为从站没有引用的build.xml).不要害怕,因为您可以通过Jenkins直接访问此信息,使用其远程访问api：例如：http:///jenkins/job//lastSuccessfulBuild/api/xml(将给你xml内容…你可以用json替换xml来获取json内容...
自动生成CHANGELOG.md
weixin_30273763的博客
12-28 1211
$ npm install -g conventional-changelog-cli $ cd my-project $ conventional-changelog -p angular -i CHANGELOG.md -s 如果你想生成所有发布的 Change log，要改为运行下面的命令 $ conventional-changelog -p angula...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值