Go-Semver-Release: Golang自动化Git仓库语义版本控制插件

go-semver-release是一个用于自动化Git仓库语义版本控制的Golang插件，它可以根据Git提交历史自动生成符合语义化版本(SemVer)规范的版本号。

主要功能

1. 自动分析Git提交历史中的约定式提交(Conventional Commits)
2. 根据提交类型自动确定版本号升级级别(major/minor/patch)
3. 支持预发布版本和构建元数据
4. 可集成到CI/CD流程中

安装

go get github.com/go-semver-release/go-semver-release

基本使用示例

package main

import (
	"fmt"
	"os"
	
	semver "github.com/go-semver-release/go-semver-release"
)

func main() {
	// 初始化配置
	config := semver.Config{
		RepoPath:      ".", // 当前目录
		PreRelease:    "",  // 预发布标识，如"beta", "rc"等
		BuildMetadata: "",  // 构建元数据
		TagPrefix:     "v", // 版本标签前缀
	}
	
	// 创建版本生成器
	generator, err := semver.NewGenerator(config)
	if err != nil {
		fmt.Printf("初始化失败: %v\n", err)
		os.Exit(1)
	}
	
	// 生成新版本
	newVersion, err := generator.Generate()
	if err != nil {
		fmt.Printf("生成版本失败: %v\n", err)
		os.Exit(1)
	}
	
	fmt.Printf("新版本: %s\n", newVersion)
}

高级配置

// 更详细的配置示例
config := semver.Config{
	RepoPath:      "/path/to/repo",
	PreRelease:    "beta", // 生成类似1.2.3-beta.1的版本
	BuildMetadata: "20230315", // 生成类似1.2.3+20230315的版本
	TagPrefix:     "v",
	VersionFile:   "VERSION", // 版本文件路径
	CommitPattern: `^(?P<type>\w+)(?:\((?P<scope>[\w\-]+)\))?:\s(?P<message>.+)`, // 自定义提交模式
	MajorPattern:  `^(breaking|major):`, // 触发主版本升级的提交类型
	MinorPattern:  `^(feat|feature):`,   // 触发次版本升级的提交类型
	PatchPattern:  `^(fix|bugfix):`,     // 触发修订版本升级的提交类型
}

CI/CD集成示例

以下是一个在GitHub Actions中使用go-semver-release的示例：

name: Release

on:
  push:
    branches:
      - main

jobs:
  release:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
        with:
          fetch-depth: 0
        
      - name: Set up Go
        uses: actions/setup-go@v2
        with:
          go-version: '1.20'
      
      - name: Install go-semver-release
        run: go install github.com/go-semver-release/go-semver-release@latest
      
      - name: Generate new version
        id: version
        run: |
          NEW_VERSION=$(go-semver-release --repo-path . --tag-prefix v)
          echo "New version: $NEW_VERSION"
          echo "new_version=$NEW_VERSION" >> $GITHUB_OUTPUT
      
      - name: Create Git tag
        uses: actions/github-script@v5
        with:
          script: |
            github.rest.git.createRef({
              owner: context.repo.owner,
              repo: context.repo.repo,
              ref: `refs/tags/v${{ steps.version.outputs.new_version }}`,
              sha: context.sha
            })

命令行使用

go-semver-release也提供了命令行工具：

# 基本用法
go-semver-release --repo-path /path/to/repo

# 带预发布版本
go-semver-release --pre-release beta

# 带构建元数据
go-semver-release --build-metadata $(date +%Y%m%d)

# 输出JSON格式
go-semver-release --output json

自定义提交约定

默认情况下，go-semver-release遵循约定式提交规范，但你可以自定义：

config := semver.Config{
	// 自定义提交模式
	CommitPattern: `^(?P<type>\w+)(?:\((?P<scope>[\w\-]+)\))?:\s(?P<message>.+)`,
	
	// 自定义哪些提交类型触发主版本升级
	MajorPattern: `^(breaking|major|api):`,
	
	// 自定义哪些提交类型触发次版本升级
	MinorPattern: `^(feat|feature|enhancement):`,
	
	// 自定义哪些提交类型触发修订版本升级
	PatchPattern: `^(fix|bugfix|docs|style|refactor|perf|test|chore):`,
}

最佳实践

1. 在团队中统一提交消息格式
2. 将版本生成集成到CI/CD流程中
3. 对于主版本升级(breaking changes)要谨慎
4. 使用预发布版本(pre-release)进行测试
5. 考虑使用版本文件来持久化版本信息

go-semver-release通过自动化版本控制减少了人为错误，确保了版本号的语义一致性，是现代化Go项目版本管理的理想选择。