登录
首页 >  Golang >  Go问答

go-git:创建本地分支的正确方法,模拟“git分支 ”的行为?

来源:stackoverflow

时间:2024-02-12 15:06:23 449浏览 收藏

欢迎各位小伙伴来到golang学习网,相聚于此都是缘哈哈哈!今天我给大家带来《go-git:创建本地分支的正确方法,模拟“git分支 ”的行为?》,这篇文章主要讲到等等知识,如果你对Golang相关的知识非常感兴趣或者正在自学,都可以关注我,我会持续更新相关文章!当然,有什么建议也欢迎在评论留言提出!一起学习!

问题内容

正如标题所示,我试图弄清楚如何使用 go-git 创建本地分支,其结果与 git cli 命令 gitbranch 相同。

据我所知,git 分支 (没有明确的 参数)做了两件事:

  1. 创建 .git/refs/heads/ 以指向当前 head 提交
  2. 创建 .git/logs/refs/heads/,并用一行记录分支的创建。

它可能会做更多的事情,但我知道它肯定会做这两件事。 (如果您知道更多内容,请分享!)

接下来的大部分内容记录了我在研究我的选择时的发现之旅,我想我现在可能已经掌握了上面的#1。不过,对于#2,我开始认为我可能是 sol,至少使用 go-git

第一个想法:repository.createbranch

我最初天真的想法是只调用 repository.createbranch,并且有一个类似的 so 问题的答案(“如何使用 go-git 检查新的本地分支?”),这似乎为这个想法提供了可信度。但一旦我开始研究细节,事情就变得非常令人困惑。

首先,repository.createbranch 采用 config.config 作为输入(为什么?),并且似乎还修改了存储库的 .git/config 文件(同样,为什么?)。我已经验证 git 分支 命令不会触及存储库的配置,并且当我调用该命令时,我当然不需要提及有关配置的任何内容。

其次,我上面链接的so答案引用了 go-gitrepository_test.go 中的代码,该代码执行以下操作:

r, _ := init(memory.newstorage(), nil) // init repo
testbranch := &config.branch{
    name:   "foo",
    remote: "origin",
    merge:  "refs/heads/foo",
}
err := r.createbranch(testbranch)

但是config.branch的定义是:

type branch struct {
    // name of branch
    name string
    // remote name of remote to track
    remote string
    // merge is the local refspec for the branch <=== ???
    merge plumbing.referencename
    ...
}

"refs/heads/foo" 不是 refspec (因为 refspec 有一个 : 分隔其 srcdst 组件)。

经过大量的绞尽脑汁和代码阅读后,我得出了(非常)初步的结论:注释中的“refspec”一词一定是错误的,而应该只是“ref”。但我对此完全不确定:如果我是对的,那么为什么这个字段名为 merge 而不仅仅是 ref

另一个初步结论是 repository.createbranch 并不是真正用于创建纯粹的本地分支,而是用于创建与远程分支存在某种关系的本地分支 - 例如,如果我正在从远程拉别人的分支。

实际上,在重新阅读 repository.createbranch 方法时,我根本不相信它真的创建了一个分支(也就是说,它创建了 .git/参考文献/头/)。除非我遗漏了一些东西(完全有可能),否则它所做的似乎只是在 .git/config 中创建一个 [branch ""] section 。但如果这是真的,为什么它是 repository 的方法?为什么它不是 config.config 的方法?

同样,还有一个相关的函数:

func (r *repository) branch(name string) (*config.branch, error)

这只会从配置返回分支信息。然而,repository 文档中的下一个函数是:

func (r *repository) branches() (storer.referenceiter, error)

它确实返回了 .git/refs/heads/ 中所有条目的迭代器。

这非常令人困惑,而且文档(就其本身而言)没有任何帮助。无论如何,除非有人能说服我,否则我很确定 createbranch 对于实际创建分支不会有太大帮助。

worktree.checkout ???

一些额外的网络搜索从旧的 d-src/go-git 存储库中发现了这两个问题:

  • 创建分支 #551 的示例
  • 创建分支?第713章

这两篇文章都提出了创建本地分支的基本方法:

wt, err := repo.Worktree()                                                                                                                                                                                                                           
if err != nil {                                                                                                                                                                                                                                  
        // deal with it                                                                                                                                                                                                                                   
}                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               
err = w.Checkout(&git.CheckoutOptions{                                                                                                                                                                                                           
        Create: true,                                                                                                                                                                                                                            
        Force:  false,                                                                                                                                                                                                                           
        Branch: plumbing.ReferenceName("refs/heads/"),                                                                                                                                                                                
})

除了这个签出新分支(git分支不这样做)的事实之外,它也无法创建.git/logs/refs/heads/。 p>

此外,作为一个潜在的非常令人讨厌的惊喜,它会清除工作树中所有未跟踪的文件。默认情况下,git checkout 保留对工作树中文件的本地修改,但在 go-git 中,您需要显式指定 keep: true,即使您已指定 force: false

这绝对违反了“最小惊讶原则”。值得庆幸的是,在我测试过的本地存储库中,它们都是旧的编辑器备份文件或我很久以前就放弃的旧项目的片段。

storer.referencestorer

碰巧的是,go-git 作者/维护者之一回应了第二个问题,并建议:

为了独立于工作树创建和删除引用,您应该使用 storer.referencestorer 来执行此操作。 请查看分支示例:https://github.com/src-d/go-git/blob/master/_examples/branch/main.go

这很好也很简单,但它只解决了分支引用的创建问题。

我在 go-git 源代码中找到的所有“log”一词似乎都是指 commit 日志,而不是 ref 日志。考虑到引用日志条目看起来与 .git 树中的其他工件完全不同,我想需要一种不同类型的存储器来创建/更新它们——并且现有的存储器都不像(对我来说) )他们这样做。

所以...

关于如何获得适当的参考日志以配合参考有什么建议吗?

(或者,也许我误解得很严重,除了上面列出的那些之外,还有一些在 go-git 中创建分支的方法,这可以满足我的要求。)


正确答案


首先,我没有足够的声誉来评论 pedro 的答案,但他的方法在 checkout 阶段失败,因为实际上没有在存储上创建分支(存储库的 storer 从未被调用)。

其次,这是我第一次听说 .git/log 目录,所以不,gitbranch 不会为该目录中的分支创建记录。

这引导我找到实际的解决方案,即作为 the go-git repo 分支示例提供的解决方案。

  • 创建分支(脱离 head):
info("git branch test")
branchname := plumbing.newbranchreferencename("test")
headref, err := r.head()
checkiferror(err)
ref := plumbing.newhashreference(branchname, headref.hash())
err = r.storer.setreference(ref)
checkiferror(err)
  • 查看分支机构
Info("git checkout test")
w, err := r.Worktree()
CheckIfError(err)
err = w.Checkout(&git.CheckoutOptions{Branch: ref.Name()})
CheckIfError(err)

但是,这样一来,.git/config 中就没有该分支的配置,因此应该调用 repo.branch 函数,但这确实非常滑稽且不直观。

文中关于的知识介绍,希望对你的学习有所帮助!若是受益匪浅,那就动动鼠标收藏这篇《go-git:创建本地分支的正确方法,模拟“git分支 ”的行为?》文章吧,也可关注golang学习网公众号了解相关技术文章。

声明:本文转载于:stackoverflow 如有侵犯,请联系study_golang@163.com删除
相关阅读
更多>
最新阅读
更多>
课程推荐
更多>