[Legacy GOPATH mode] How to `go get` private repos using SSH key auth instead of password auth.

gistfile1.md

WARNING: If you're reading this in 2021 or later, you're likely better served by reading:

• https://go.dev/cmd/go#hdr-Configuration_for_downloading_non_public_code
• https://go.dev/ref/mod#private-modules

(This gist was created in 2013 and targeted the legacy GOPATH mode.)

$ ssh -A vm
$ git config --global url."[email protected]:".insteadOf "https://github.com/"
$ cat ~/.gitconfig
[url "[email protected]:"]
	insteadOf = https://github.com/
$ go get github.com/private/repo && echo Success!
Success!

Sources:

• https://docs.github.com/en/developers/overview/using-ssh-agent-forwarding
• https://golang.org/doc/faq#git_https
• https://git-scm.com/docs/git-config#Documentation/git-config.txt-urlltbasegtinsteadOf

As a note to everybody here. When adding the overwrite to .gitconfig like so:

[url "ssh://[email protected]/"]
	insteadOf = "https://example.com/"

you will also need your env var:

export GOPRIVATE="example.com"

This should actually be part of the official docs.

hrm, what about sub-projects on gitlab?

$ go get gitlab.com/SomeOrg/sub-project/project
# cd .; git clone -- https://gitlab.com/SomeOrg/sub-project.git /home/bhundven/go/src/gitlab.com/SomeOrg/sub-project
Cloning into '/home/bhundven/go/src/gitlab.com/SomeOrg/sub-project'...
Warning: Permanently added 'gitlab.com,172.65.251.78' (ECDSA) to the list of known hosts.
remote: 
remote: ========================================================================
remote: 
remote: The project you were looking for could not be found.
remote: 
remote: ========================================================================
remote: 
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.
package gitlab.com/SomeOrg/sub-project/project: exit status 128

Tried:

[url "[email protected]:SomeOrg"]
        insteadOf = https://gitlab.com/SomeOrg

Maybe not an issue for here, but for here: https://gitlab.com/gitlab-org/gitlab-foss/-/issues/30785

For those who will meet with the same problem: git config --global url."[email protected]:".insteadOf "https://github.com/" works but the local version (git config --local url."[email protected]:".insteadOf "https://github.com/") - doesn't. Likely a git bug.

@XVilka Did you try add local config to $GOPATH/src/github.com/private/repo (by cd into it first)? In fact the local config of that repo is loaded, instead of the repo that you are working on now.

This is a very old gist and may not be applicable by now. I added a warning to the top:

WARNING: This gist was created in 2013 and targets the legacy GOPATH mode. If you're reading this in 2021 or later, you're likely better served by reading https://tip.golang.org/cmd/go/#hdr-Configuration_for_downloading_non_public_code and https://golang.org/ref/mod#private-modules.

For those who will meet with the same problem: git config --global url."[email protected]:".insteadOf "https://github.com/" works but the local version (git config --local url."[email protected]:".insteadOf "https://github.com/") - doesn't. Likely a git bug.

I encountered the same issue, even if I tried to setup environment variable GIT_CONFIG to point to my local git config file, it is ignored... Do you have a solution that avoids using global ~/.gitconfig file now?

BTW, I keep updating my fork of this gist: https://gist.github.com/StevenACoffman/866b06ed943394fbacb60a45db5982f2