如何通过go-github客户端验证git SHA是否属于指定git分支

以下是两种可行的落地方式：

方案1：调用GitHub API实现（无需本地克隆仓库） #

适合服务端、CI/CD等没有本地仓库副本的场景，直接使用官方go-github客户端调用GitHub开放接口完成校验。

• 依赖安装
  执行命令安装依赖：

  go get github.com/google/go-github/v58/github
  go get golang.org/x/oauth2
  

• 核心逻辑
  调用GitHub提交比较接口Repositories.CompareCommits，将目标分支作为base，待校验SHA作为head，通过返回的状态判断归属关系：
  • 返回状态为behind或identical：说明SHA存在于目标分支的提交历史中
  • 返回状态为ahead或diverged：说明SHA不属于目标分支
• 示例代码片段

  package main
  
  import (
    "context"
    "github.com/google/go-github/v58/github"
    "golang.org/x/oauth2"
  )
  
  func isSHAInBranch(ctx context.Context, owner, repo, branch, sha string, token string) (bool, error) {
    ts := oauth2.StaticTokenSource(
      &oauth2.Token{AccessToken: token},
    )
    tc := oauth2.NewClient(ctx, ts)
    client := github.NewClient(tc)
  
    compare, _, err := client.Repositories.CompareCommits(ctx, owner, repo, branch, sha, nil)
    if err != nil {
      return false, err
    }
    status := compare.GetStatus()
    return status == "behind" || status == "identical", nil
  }
  

• 注意：如果两个提交差异超过250个，该REST API会报错，此时可以改用GitHub GraphQL API查询提交的祖先链关系，适配大跨度提交的校验场景。

方案2：本地Git操作实现（已有本地仓库副本场景） #

如果本地已经克隆了目标仓库，可直接使用go-git库完成本地校验，无API速率限制，性能更高。

• 依赖安装
  执行命令安装依赖：

  go get github.com/go-git/go-git/v5
  

• 核心逻辑
  遍历目标分支HEAD的所有祖先提交，校验是否存在匹配的SHA即可，逻辑和原生git branch --contains完全一致。
• 示例代码片段

  package main
  
  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 isSHAInBranchLocal(repoPath, branchName, targetSHA string) (bool, error) {
    repo, err := git.PlainOpen(repoPath)
    if err != nil {
      return false, err
    }
    // 获取目标分支的HEAD提交
    branchRef, err := repo.Reference(plumbing.NewBranchReferenceName(branchName), true)
    if err != nil {
      return false, err
    }
    branchCommit, err := repo.CommitObject(branchRef.Hash())
    if err != nil {
      return false, err
    }
    targetHash := plumbing.NewHash(targetSHA)
    // 遍历分支所有祖先提交
    iter := object.NewCommitPreorderIter(branchCommit, nil, nil)
    defer iter.Close()
    found := false
    err = iter.ForEach(func(c *object.Commit) error {
      if c.Hash == targetHash {
        found = true
        return plumbing.ErrStop
      }
      return nil
    })
    return found, err
  }
  

额外注意事项 #

• 调用GitHub API时如果是私有仓库，需要给访问令牌配置仓库的读取权限，认证后API速率限制为5000次/小时，未认证仅60次/小时。
• 大仓库使用本地方案时，建议提前配置定时任务同步仓库最新提交，避免校验结果过期。

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