如何使用go-git包获取指定git哈希对应标签 实现git describe效果

git的标签分为两类，TagObject方法仅能查询到注解标签的对象：

• 轻量标签：本质是直接指向commit的引用，没有独立的标签对象存储，调用TagObject会直接返回nil
• 注解标签：有独立的标签对象存储打标人、备注、时间等元数据，最终指向目标commit，只有这类标签可以通过TagObject查询到
  你直接拿commit哈希调用TagObject当然返回nil，因为commit哈希本身不是标签对象的哈希。

第一步：构建commit哈希到标签的映射 #

该逻辑同时兼容轻量标签和注解标签：

import (
    "github.com/go-git/go-git/v5"
    "github.com/go-git/go-git/v5/plumbing"
    "github.com/go-git/go-git/v5/plumbing/object"
)

func buildCommitToTagMap(repo *git.Repository) (map[plumbing.Hash][]string, error) {
    commitToTags := make(map[plumbing.Hash][]string)
    tags, err := repo.Tags()
    if err != nil {
        return nil, err
    }
    defer tags.Close()

    err = tags.ForEach(func(ref *plumbing.Reference) error {
        tagName := ref.Name().Short()
        targetHash := ref.Hash()

        // 尝试判断是否为注解标签
        tagObj, err := repo.TagObject(targetHash)
        if err == nil {
            // 是注解标签，取它指向的commit哈希
            targetHash = tagObj.Target
        }

        commitToTags[targetHash] = append(commitToTags[targetHash], tagName)
        return nil
    })
    return commitToTags, err
}

第二步：实现describe核心逻辑 #

从HEAD开始向上遍历提交历史，找到最近的带标签的提交，没有标签则返回短commit哈希：

func GitDescribe(repo *git.Repository) (string, error) {
    // 获取HEAD对应的commit
    headRef, err := repo.Head()
    if err != nil {
        return "", err
    }
    headCommit, err := repo.CommitObject(headRef.Hash())
    if err != nil {
        return "", err
    }

    // 构建标签映射
    commitToTags, err := buildCommitToTagMap(repo)
    if err != nil {
        return "", err
    }

    // 遍历提交历史找最近的带标签提交
    commitIter := object.NewCommitPreorderIter(headCommit, nil, nil)
    defer commitIter.Close()

    var taggedCommit *object.Commit
    err = commitIter.ForEach(func(c *object.Commit) error {
        if _, ok := commitToTags[c.Hash]; ok {
            taggedCommit = c
            return plumbing.ErrStop
        }
        return nil
    })
    if err != nil && err != plumbing.ErrStop {
        return "", err
    }

    if taggedCommit != nil {
        // 找到标签直接返回，多个标签的话可以自定义选择逻辑
        return commitToTags[taggedCommit.Hash][0], nil
    }

    // 没有匹配到标签返回7位短哈希，对应--always参数效果
    return headCommit.Hash.String()[:7], nil
}

调用示例 #

// 打开本地仓库
repo, err := git.PlainOpen("你的本地仓库路径")
if err != nil {
    panic(err)
}
res, err := GitDescribe(repo)
if err != nil {
    panic(err)
}
fmt.Println("describe结果：", res)

如果需要完全实现原生git describe带提交计数、哈希后缀的效果（例如v1.0.0-3-g123abc），只需要在找到最近的标签提交后，计算HEAD和该提交之间的提交数，拼接对应后缀即可。

内容的提问来源于stack exchange，提问作者Haimantika Mitra