git-chglog 是一款基于 git 提交记录生成结构化变更日志的工具，适用于 golang 项目。1. 安装 git-chglog 可通过 go install 命令快速完成；2. 初始化配置文件后可自定义模板与配置；3. 需遵循 conventional commits 规范提交 commit 以确保正确分类；4. 通过命令生成 changelog.md 文件并可结合 ci/cd 自动化流程使用，提升版本发布效率。
为 Golang 模块生成变更日志，使用 git-chglog 是一个高效、标准化的做法。它能基于 Git 提交记录自动生成结构清晰的 CHANGELOG.md 文件，适合用于模块版本更新时的文档维护。
什么是 git-chglog？
git-chglog 是一个开源工具，专门用来从 Git 的 commit 中提取信息，并按照指定格式生成变更日志（CHANGELOG）。它支持多种模板风格，也允许你根据项目规范进行自定义。相比手动编写 changelog，它更自动化、统一，也更容易集成进 CI/CD 流程中。
如何在 Golang 项目中集成 git-chglog
1. 安装 git-chglog
最简单的方式是通过
go install
安装：
立即学习“go语言免费学习笔记（深入）”；
go install github.com/git-chglog/git-chglog/cmd/git-chglog@latest
安装完成后，可以通过运行
git-chglog --version
验证是否成功。
2. 初始化配置文件
在项目根目录下执行以下命令来生成默认配置文件：
git-chglog --init
这个命令会在当前目录创建
.chglog
目录，里面包含默认的配置文件和模板。主要关注的是
config.yml
和
default.tpl
。
你可以根据需要修改模板内容，比如添加图标、调整标题层级等。
3. 按照约定提交 commit
git-chglog 默认识别 Conventional Commits 规范的提交信息。例如：
feat: 新增功能fix: 修复 bugdocs: 更新文档chore: 构建或辅助工具改动
这类格式能让 git-chglog 正确分类变更内容并归类到对应章节。
如果你已经有历史提交但不符合规范，可以考虑先整理最近几次关键提交，或者使用
--sort
参数让工具自动归类。
4. 生成 CHANGELOG.md
在每次发布新版本前运行以下命令：
git-chglog -o CHANGELOG.md
这会根据最新的 Git 提交记录生成或更新 CHANGELOG.md 文件。
如果你想只生成某个版本的变更记录，可以用：
git-chglog v1.0.1 > CHANGELOG_v1.0.1.md
常见问题与建议
生成内容为空？
确保你的 commit 符合 Conventional Commits 规范，否则可能无法被识别。也可以检查
.chglog/config.yml
中的
filter_commits
设置是否过于严格。
不想每次都手动运行怎么办？
可以将 git-chglog 集成进你的 CI/CD 流水线，比如 GitHub Actions，在 tag 推送后自动更新 changelog 并提交 PR 或直接推送到主分支。
想按不同类别分组展示？
修改模板文件即可实现。例如，把 feat 放在 Features 小节，fix 放在 Bug Fixes 小节，这样视觉上更清晰。
如何配合 semver 使用？
git-chglog 本身不处理语义化版本号，但你可以结合
git tag
来标记版本，再用 git-chglog 生成对应版本的 changelog。
示例：GitHub Actions 自动化流程
下面是一个简单的 GitHub Action 工作流，用于在打 tag 后自动生成 changelog 并提交：
name: Generate Changelogon: push: tags: - 'v*'jobs: build: runs-on: ubuntu-latest steps: - name: Checkout code uses: actions/checkout@v3 with: fetch-depth: 0 - name: Install git-chglog run: go install github.com/git-chglog/git-chglog/cmd/git-chglog@latest - name: Generate changelog run: git-chglog -o CHANGELOG.md - name: Commit and push changes run: | git config --local user.email "action@github.com" git config --local user.name "GitHub Action" git add CHANGELOG.md git commit -m "docs: update changelog for ${{ github.ref }}" git push origin HEAD:${{ github.ref }}
基本上就这些。用好 git-chglog 的关键是规范 commit 格式 + 合理配置模板。虽然步骤看起来不多，但很容易因为格式不一致导致输出结果不如预期，所以建议团队内部统一 commit 规范。
以上就是怎样为Golang模块生成变更日志 集成git-chglog自动化工具链的详细内容，更多请关注创想鸟其它相关文章！
版权声明：本文内容由互联网用户自发贡献，该文观点仅代表作者本人。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。
如发现本站有涉嫌抄袭侵权/违法违规的内容， 请发送邮件至 chuangxiangniao@163.com 举报，一经查实，本站将立刻删除。
发布者：程序猿，转转请注明出处：https://www.chuangxiangniao.com/p/1399610.html
微信扫一扫 
支付宝扫一扫 
