Golang模块日志生成与自动化发布技巧

在Golang实战开发的过程中，我们经常会遇到一些这样那样的问题，然后要卡好半天，等问题解决了才发现原来一些细节知识点还是没有掌握好。今天golang学习网就整理分享《Golang模块变更日志生成与自动化发布实践》，聊聊，希望可以帮助到正在努力赚钱的你。

要为Golang模块生成变更日志并实现自动化版本发布，1. 规范提交信息，2. 使用Git标签进行版本控制，3. 利用工具如GoReleaser、git-chglog等生成变更日志，4. 通过CI/CD工具（如GitHub Actions）自动化发布流程。具体操作包括采用Conventional Commits规范提交信息，在每次发布时打Git标签，配置GoReleaser根据提交前缀分组生成日志并排除无关提交，使用GitHub Actions在推送标签时自动运行GoReleaser完成发布任务。选择工具时需考虑兼容性、自定义能力、集成性和易用性，GoReleaser适合综合发布需求，git-chglog适合仅需生成日志的场景。对于多贡献者、多模块项目，应统一提交规范，合理组织代码结构，并按模块配置日志生成规则。可在提交中添加Closes或Refs字段关联Issue或PR，并在模板中引用以丰富日志内容。

为Golang模块生成变更日志，并通过自动化实现版本发布，核心在于追踪代码变更、规范提交信息以及利用工具自动生成日志和发布流程。这不仅能提高开发效率，还能确保版本迭代的可追溯性。

解决方案

1. 规范提交信息： 采用约定式提交（Conventional Commits）规范，例如使用feat: 添加新功能、fix: 修复bug、chore: 更新依赖等前缀。这为后续自动化生成变更日志提供了基础。

   

2. 使用Git标签进行版本控制： 每次发布新版本时，都应打上Git标签，例如v1.0.0。这方便追踪特定版本的代码状态。

3. 利用工具生成变更日志： 有很多工具可以根据Git提交信息自动生成变更日志，例如：

   
   • GoReleaser: 不仅可以生成变更日志，还可以自动化构建、打包和发布Go二进制文件。
   • git-chglog: 一个专门用于生成变更日志的工具，支持自定义模板。
   • standard-version: 虽然主要用于JavaScript项目，但也可以通过配置用于Go项目。

   以GoReleaser为例，可以在.goreleaser.yaml文件中配置变更日志的生成方式，例如：

   changelog:
     sort: asc
     filters:
       exclude:
         - '^docs:'
         - '^test:'
     use: github-releaser
     groups:
       - title: '✨ Features'
         regexp: '^feat:'
       - title: '? Bug Fixes'
         regexp: '^fix:'
       - title: '? Maintenance'
         regexp: '^chore:'

   这个配置会将提交信息按照feat、fix、chore等前缀分组，并排除docs和test相关的提交。

4. 自动化版本发布流程： 可以使用CI/CD工具（如GitHub Actions、GitLab CI、Jenkins）自动化版本发布流程。当有新的Git标签被推送时，CI/CD工具可以自动运行GoReleaser等工具，生成变更日志、构建二进制文件、打包发布到GitHub Releases或其他软件仓库。

   一个简单的GitHub Actions示例：

   name: Release
   
   on:
     push:
       tags:
         - 'v*'
   
   jobs:
     release:
       runs-on: ubuntu-latest
       steps:
         - uses: actions/checkout@v3
           with:
             fetch-depth: 0
         - uses: goreleaser/goreleaser-action@v2
           with:
             version: latest
             args: release --rm-dist
           env:
             GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

   这个Action会在每次推送以v开头的Git标签时运行GoReleaser，并自动发布到GitHub Releases。

如何选择合适的变更日志生成工具？

选择变更日志生成工具，需要考虑以下几个因素：

• 与Go项目的兼容性： 确保工具能够正确解析Go项目的Git提交信息和代码结构。
• 自定义能力： 工具是否支持自定义模板，以便生成符合项目需求的变更日志格式。
• 集成性： 工具是否容易集成到现有的CI/CD流程中。
• 易用性： 工具是否易于配置和使用。

GoReleaser由于其强大的功能和与Go项目的良好兼容性，通常是首选。但如果只需要生成变更日志，git-chglog也是一个不错的选择。

如何处理复杂的变更日志场景，例如多个贡献者、多个模块？

在复杂的项目中，可能会有多个贡献者和多个模块。为了更好地管理变更日志，可以采取以下措施：

• 统一提交规范： 确保所有贡献者都遵循统一的提交规范，例如约定式提交。
• 使用Git子模块或目录结构： 如果项目包含多个模块，可以使用Git子模块或目录结构来组织代码。
• 配置变更日志生成工具： 根据项目结构配置变更日志生成工具，以便正确识别不同模块的变更。
• 使用GitHub Actions的矩阵构建： 如果项目包含多个模块，可以使用GitHub Actions的矩阵构建功能，为每个模块单独生成变更日志。

例如，如果项目包含两个模块moduleA和moduleB，可以在.goreleaser.yaml文件中配置：

builds:
  - id: moduleA
    main: ./moduleA
    binary: moduleA
  - id: moduleB
    main: ./moduleB
    binary: moduleB

changelog:
  use: github-releaser
  groups:
    - title: 'Module A Features'
      regexp: '^moduleA:feat:'
    - title: 'Module A Bug Fixes'
      regexp: '^moduleA:fix:'
    - title: 'Module B Features'
      regexp: '^moduleB:feat:'
    - title: 'Module B Bug Fixes'
      regexp: '^moduleB:fix:'

然后在提交信息中添加模块前缀，例如moduleA:feat: 添加新功能。

如何在变更日志中包含更详细的信息，例如链接到相关的Issue或PR？

可以在提交信息中包含Issue或PR的链接，然后在变更日志生成工具的模板中使用这些链接。

例如，可以在提交信息中添加Closes #123或Refs #456，然后在GoReleaser的模板中使用{{ .Closes }}或{{ .Refs }}来获取这些链接。

changelog:
  use: github-releaser
  template: |
    {{ range .Entries }}
    - {{ .Title }} ([{{ .Commit.ShortSHA }}](https://github.com/your-org/your-repo/commit/{{ .Commit.SHA }}))
      {{- if .Closes }}
      Closes {{ .Closes }}
      {{- end }}
      {{- if .Refs }}
      Refs {{ .Refs }}
      {{- end }}
    {{ end }}

这个模板会将提交标题、Commit SHA、Closes和Refs信息包含在变更日志中。

今天带大家了解了的相关知识，希望对你有所帮助；关于Golang的技术知识我们会一点点深入介绍，欢迎大家关注golang学习网公众号，一起学习编程~