0Pricing
Git & GitHub Professional Workflow · 课时

生成变更日志与发布说明

学习如何根据 Git 历史和约定式提交生成清晰的变更日志与自动化发布说明。

生成变更日志与发布说明 是 CoddyKit 上的免费 Git & GitHub Professional Workflow 课时。 这是第 4 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Git & GitHub Professional Workflow 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Git & GitHub Professional Workflow 课程共包含 4 节课。

什么是变更日志

变更日志是针对每个版本整理的、便于人类阅读的重要变更列表。它通常存放在仓库根目录下名为 CHANGELOG.md 的文件中。

变更日志为何重要

用户和团队成员会通过变更日志了解：

  • 新功能
  • 错误修复
  • 破坏性变更

变更日志可以让升级更安全、更快速。

规范的变更日志格式

一种常见约定是将条目归类到以下标题下：新增、变更、修复、移除。

## [1.2.0] - 2024-05-01
### Added
- Search filters
### Fixed
- Login redirect bug

约定式提交

约定式提交使用 feat:、fix: 和 BREAKING CHANGE: 等前缀，以便工具自动生成变更日志。

feat: add CSV export
fix: handle empty cart
feat!: drop Node 14 support

列出某个标签之后的提交

您可以使用带有标签范围的 git log，预览上一个版本发布以来发生的变更。

git log v1.1.0..HEAD --oneline

用于发布说明的简洁日志

将日志格式化为适合粘贴到发布说明中的项目符号行。

git log v1.1.0..HEAD --pretty=format:'- %s'

自动生成变更日志的工具

标准版本工具或约定式变更日志工具会读取约定式提交，并生成变更日志，同时提升版本号。

npx standard-version

GitHub 自动生成的说明

创建发布版本时，GitHub 可以根据已合并的拉取请求自动生成发布说明。

gh release create v1.2.0 --generate-notes

使用标签分类

.github/release.yml 文件会将 PR 标签映射到变更日志部分，因此发布说明可以自动将错误修复和功能分组。

changelog:
  categories:
    - title: Features
      labels: [feature]

发布前进行审查

发布前务必阅读生成的说明。自动化工具会起草内容，但应由人工修改措辞并突出显示破坏性变更。

关联到发布版本

让每条变更日志条目都链接到其 Git 标签和发布页面，以便读者直接查看确切的差异。

[1.2.0]: https://github.com/you/repo/compare/v1.1.0...v1.2.0

快速检查

测试您对变更日志和发布说明的理解。

回顾

您学会了如何生成变更日志：

  • 使用规范的变更日志格式
  • 使用约定式提交驱动自动化流程
  • git log v1..HEAD 可预览变更
  • gh release create --generate-notes 可根据 PR 起草发布说明

常见问题解答

「生成变更日志与发布说明」课时是免费的吗？

是的 — 「生成变更日志与发布说明」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Git & GitHub Professional Workflow 课程的其余内容，请升级到 CoddyKit PRO。 Git & GitHub Professional Workflow 课程共包含 4 节课。

「生成变更日志与发布说明」这节课中我会学到什么？

学习如何根据 Git 历史和约定式提交生成清晰的变更日志与自动化发布说明。 你通过在浏览器中直接运行的动手代码来练习 Git & GitHub Professional Workflow，全天候 AI 导师会在你学习这节课的过程中回答你的问题。

学习 Git & GitHub Professional Workflow 需要有经验吗？

无需任何先前经验。CoddyKit 上的 Git & GitHub Professional Workflow 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 4 节课，共 4 节。

「生成变更日志与发布说明」课时需要多长时间？

大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。

我能在这节 Git & GitHub Professional Workflow 课中编写并运行代码吗？

能。每节 Git & GitHub Professional Workflow 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。

此课程中的所有课时

  1. 使用标签进行语义化版本控制
  2. 创建与管理发布版本
  3. 发布分支与热修复
  4. 生成变更日志与发布说明
← 返回 Git & GitHub Professional Workflow