使用 .github/realse.yml 自动生成 release change log

原创

于 2025-03-22 00:07:41 发布 · 1.3k 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#GitHub发布日志生成 #自动化发布说明生成 #版本管理最佳实践 #github release

🚀 发现 gone-io/gone：一个优雅的 Go 依赖注入框架！💻 它让您的代码更简洁、更易测试。🔍 框架轻量却功能强大，完美平衡了灵活性与易用性。⭐ 如果您喜欢这个项目，请给我们点个星！🌟 您的支持是我们前进的动力！🤝 欢迎贡献代码或提出建议，一起让 gone 变得更好！👨‍💻 #golang #依赖注入 #开源 👉github.com/gone-io/gone

文章目录

在 GitHub 项目开发中，发布版本是一个重要环节。为了让发布说明更加规范和自动化，GitHub 提供了 .github/release.yml 配置文件，帮助开发者自动生成结构化的发布说明。本文将详细介绍如何使用这个功能。

什么是 release.yml？

release.yml 是 GitHub 提供的一个配置文件，放置在项目的 .github 目录下。它可以帮助你自动从 Pull Request 中提取信息，并按照预定义的分类组织发布说明。

基本配置

首先，在项目根目录创建 .github/release.yml 文件：

# .github/release.yml

changelog:
  categories:
    - title: 新功能 🎉
      labels:
        - feature
        - enhancement
    - title: Bug 修复 🐛
      labels:
        - bug
        - fix
    - title: 文档更新 📚
      labels:
        - documentation
    - title: 依赖更新 ⬆️
      labels:
        - dependencies
    - title: 其他变更
      labels:
        - "*"