在 Go 中使用分叉包导入

Question

假设您有一个位于 github.com/someone/repo 的存储库，并且您将其 fork 到 github.com/you/repo。你想使用你的 fork 而不是主 repo，所以你做一个

go get github.com/you/repo

现在此 repo 中的所有导入路径都将被“损坏”，这意味着，如果存储库中有多个包通过绝对 URL 相互引用，它们将引用源，而不是 fork。

有没有更好的方法将其手动克隆到正确的路径中？

git clone git@github.com:you/repo.git $GOPATH/src/github.com/someone/repo

Answer 1

如果您使用的是go modules。你可以使用replace 指令

replace 指令允许您提供另一个导入路径，该路径可能 是位于 VCS（GitHub 或其他地方）或您的 具有相对或绝对文件路径的本地文件系统。新进口 使用来自replace 指令的路径，无需更新 在实际源代码中导入路径。

所以您可以在 go.mod 文件中执行以下操作

module github.com/yogeshlonkar/openapi-to-postman

go 1.12

require (
    github.com/someone/repo v1.20.0
)

replace github.com/someone/repo => github.com/you/repo v3.2.1

v3.2.1 是你的仓库中的标签。也可以通过 CLI 完成

go mod edit -replace="github.com/someone/repo@v0.0.0=github.com/you/repo@v1.1.1"

Answer 2

处理拉取请求

• fork 一个仓库github.com/someone/repo 到github.com/you/repo
• 下载原码：go get github.com/someone/repo
• 在那里：cd "$(go env GOPATH)/src"/github.com/someone/repo
• 启用上传到您的分叉：git remote add myfork https://github.com/you/repo.git
• 将您的更改上传到您的仓库：git push myfork

http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html

在项目中使用包

https://github.com/golang/go/wiki/PackageManagementTools

Answer 3

解决它的一种方法是 Ivan Rave 和 http://blog.campoy.cat/2014/03/github-and-go-forking-pull-requests-and.html 建议的方法——分叉的方式。

另一种方法是解决 golang 行为。当您go get 时，golang 会以与存储库 URI 中相同的名称来布置您的目录，这就是麻烦开始的地方。

如果您发出自己的git clone，则可以将您的存储库克隆到以原始存储库命名的路径上的文件系统上。

假设原始存储库位于 github.com/awsome-org/tool 并且您将其 fork 到 github.com/awesome-you/tool，您可以：

cd $GOPATH
mkdir -p {src,bin,pkg}
mkdir -p src/github.com/awesome-org/
cd src/github.com/awesome-org/
git clone git@github.com:awesome-you/tool.git # OR: git clone https://github.com/awesome-you/tool.git
cd tool/
go get ./...

golang 非常乐意继续使用此存储库，并且实际上并不关心某些上层目录的名称为 awesome-org 而 git 远程是 awesome-you。 awesome-org 的所有导入都通过您刚刚创建的目录进行解析，该目录是您的本地工作集。

更多篇幅请看我的博文：Forking Golang repositories on GitHub and managing the import path

编辑：固定目录路径

Answer 4

如果您的分叉只是临时的（即您打算将其合并），那么只需在原地进行开发，例如在$GOPATH/src/launchpad.net/goamz。

然后您使用版本控制系统的功能（例如git remote）将上游存储库而不是原始存储库设为您的存储库。

通过go get 使其他人更难使用您的存储库，但更容易将其集成到上游。

事实上，我在 lp:~nick-craig-wood/goamz/goamz 有一个 goamz 存储库，我正是以这种方式开发的。也许有一天作者会合并它！

Answer 5

这是一种适用于所有人的方法：

使用 github fork 到“my/repo”（只是一个例子）：

go get github.com/my/repo
cd ~/go/src/github.com/my/repo
git branch enhancement
rm -rf .
go get github.com/golang/tools/cmd/gomvpkg/…
gomvpkg <<oldrepo>> ~/go/src/github.com/my/repo
git commit

每次使代码更好时重复：

git commit
git checkout enhancement
git cherry-pick <<commit_id>>
git checkout master

为什么？这使您可以拥有任何go get 都可以使用的存储库。它还允许您维护和增强对拉取请求有益的分支。它不会用“供应商”使 git 膨胀，它保留了历史，并且构建工具可以理解它。

Answer 6

这个问题的答案是，如果你 fork 一个包含多个包的 repo，你将需要重命名所有相关的导入路径。这在很大程度上是一件好事，因为您已经分叉了所有这些包，并且导入路径应该反映这一点。

Answer 7

您可以克隆到任何您想要的位置，而不是克隆到特定位置。 然后，您可以运行这样的命令，让 Go 引用本地版本：

go mod edit -replace github.com/owner/repo=../repo

https://golang.org/cmd/go#hdr-Module_maintenance

Answer 8

同时使用 vendoring 和子模块

1. fork github 上的 lib（本例中为 go-mssqldb）
2. 添加一个 submodule，它将你的 fork 克隆到你的 vendor folder 中，但具有上游 repo 的路径
3. 更新源代码中的import 语句以指向供应商文件夹（不包括vendor/ 前缀）。例如。 vendor/bob/lib => import "bob/lib"

例如

cd ~/go/src/github.com/myproj

mygithubuser=timabell
upstreamgithubuser=denisenkom
librepo=go-mssqldb

git submodule add "git@github.com:$mygithubuser/$librepo" "vendor/$upstreamgithubuser/$librepo"

为什么

这解决了所有我在尝试自己解决这个问题时听说和遇到的问题。

• lib 中的内部包引用现在可以工作了，因为上游的路径没有改变
• 重新签出您的项目是可行的，因为子模块系统在正确提交时从您的 fork 中获取它，但在上游文件夹路径中
• 您不必知道手动破解路径或使用 go 工具。

更多信息

• https://git-scm.com/book/en/v2/Git-Tools-Submodules
• How do I fix the error message "use of an internal package not allowed" when go getting a golang package?
• https://github.com/denisenkom/go-mssqldb/issues/406
• https://github.com/golang/go/wiki/PackageManagementTools#go15vendorexperiment

Answer 9

现代答案（至少 1.15 或更高版本）。

go mod init github.com/theirs/repo

创建一个显式的初始化参数，它是原始包名称。如果您不包含 repo 名称，它将假定为 gopath 中的名称。但是当你使用 go 模块时，它们不再关心它们在磁盘上的位置，或者 git 实际从哪里提取依赖项。

Answer 10

为了自动化这个过程，我编写了一个小脚本。您可以在我的blog 上找到更多详细信息，以便将“gofork”之类的命令添加到您的 bash。

function gofork() {
  if [ $# -ne 2 ] || [ -z "$1" ] || [ -z "$2" ]; then
    echo 'Usage: gofork yourFork originalModule'
    echo 'Example: gofork github.com/YourName/go-contrib github.com/heirko/go-contrib'
    return
  fi
   echo "Go get fork $1 and replace $2 in GOPATH: $GOPATH"
   go get $1
   go get $2
   currentDir=$PWD
   cd $GOPATH/src/$1
   remote1=$(git config --get remote.origin.url)
   cd $GOPATH/src/$2
   remote2=$(git config --get remote.origin.url)
   cd $currentDir
   rm -rf $GOPATH/src/$2
   mv $GOPATH/src/$1 $GOPATH/src/$2
   cd $GOPATH/src/$2
   git remote add their $remote2
   echo Now in $GOPATH/src/$2 origin remote is $remote1
   echo And in $GOPATH/src/$2 their remote is $remote2
   cd $currentDir
}

export -f gofork

Answer 11

在您的 Gopkg.toml 文件中，在下面添加这些块

[[constraint]]
  name = "github.com/globalsign/mgo"
  branch = "master"
  source = "github.com/myfork/project2"

因此它将使用分叉的project2 代替github.com/globalsign/mgo

Answer 12

您可以使用命令go get -f 为您获取分叉回购