Clones a repository, and if it is a fork of a GitHub repository, sets that repo as a remote named 'upstream'.
Please note, that this utility makes API queries to determine if your
repo is a fork, and depending on your source IP or your use of the API,
you may be throttled and limited in the numer of API queries you can
make. The solution is to add a token for GitHub in your .gitconfig
file as documented here.
git clone-fork will then use this token when talking to GitHub.
Often, I find myself repeating the same commands over and over:
- git clone http://github.com/stbenjam/foo.git
- cd foo
- git remote add upstream http://github.com/bigcorp/foo.git
This automates that process, by querying the GitHub API to find out if the repo is a fork, and if so, creating a remote for it.
- Install go
- Run
go get -u github.com/stbenjam/git-clone-fork - Call as
git clone-forkorgit-clone-fork
git clone-fork user/repo|<clone url>
-h Forces use of HTTP
-r [name] changes the name of 'upstream' to something else
$ git clone-fork stbenjam/installer
Cloning into 'installer'...
remote: Enumerating objects: 8, done.
remote: Counting objects: 100% (8/8), done.
remote: Compressing objects: 100% (8/8), done.
remote: Total 88745 (delta 0), reused 2 (delta 0), pack-reused 88737
Receiving objects: 100% (88745/88745), 68.22 MiB | 19.48 MiB/s, done.
Resolving deltas: 100% (53901/53901), done.
setting fork remote (upstream): [email protected]:openshift/installer.git
$ cd installer/
$ git remote -v
origin [email protected]:stbenjam/installer.git (fetch)
origin [email protected]:stbenjam/installer.git (push)
upstream [email protected]:openshift/installer.git (fetch)
upstream [email protected]:openshift/installer.git (push)
$ git clone-fork -r potato stbenjam/installer
Cloning into 'installer'...
remote: Enumerating objects: 8, done.
remote: Counting objects: 100% (8/8), done.
remote: Compressing objects: 100% (8/8), done.
remote: Total 88745 (delta 0), reused 2 (delta 0), pack-reused 88737
Receiving objects: 100% (88745/88745), 68.22 MiB | 17.68 MiB/s, done.
Resolving deltas: 100% (53901/53901), done.
Checking out files: 100% (12457/12457), done.
setting fork remote (potato): [email protected]:openshift/installer.git
$ cd installer
$ git remote -v
origin [email protected]:stbenjam/installer.git (fetch)
origin [email protected]:stbenjam/installer.git (push)
potato [email protected]:openshift/installer.git (fetch)
potato [email protected]:openshift/installer.git (push)
$ git clone-fork -h stbenjam/installer
Cloning into 'installer'...
remote: Enumerating objects: 8, done.
remote: Counting objects: 100% (8/8), done.
remote: Compressing objects: 100% (8/8), done.
remote: Total 88745 (delta 0), reused 2 (delta 0), pack-reused 88737
Receiving objects: 100% (88745/88745), 68.22 MiB | 18.22 MiB/s, done.
Resolving deltas: 100% (53901/53901), done.
Checking out files: 100% (12457/12457), done.
setting fork remote (upstream): https://github.com/openshift/installer.git
$ cd installer
$ git remote -v
origin https://github.com/stbenjam/installer.git (fetch)
origin https://github.com/stbenjam/installer.git (push)
upstream https://github.com/openshift/installer.git (fetch)
upstream https://github.com/openshift/installer.git (push)
See LICENSE
