Git to Go. Like McDonald's but tastier.
Go C Other
Latest commit 4a14260 Jan 20, 2017 @carlosmn carlosmn committed on GitHub Merge pull request #362 from libgit2/cmn/master-tip-static
Update master to latest libgit2 and build statically
Permalink
Failed to load latest commit information.
script Get rid of the with-static.sh script Oct 31, 2016
vendor Update libgit2 to df4dfaad Jan 20, 2017
.gitmodules Remove left-over submodule configuration Jun 7, 2014
.travis.yml Merge remote-tracking branch 'origin/next' Jan 20, 2017
LICENSE Initial commit Mar 5, 2013
Makefile Get rid of the with-static.sh script Oct 31, 2016
README.md Update the description of the branches in README. Jan 20, 2017
blame.go Upgrade to libgit2 to 0f9d15493d5d8ad4353dd7beed52c9567334f6e5 Feb 17, 2016
blame_test.go Run the tests in parallel Aug 27, 2016
blob.go Merge remote-tracking branch 'upstream/master' into next Aug 27, 2016
blob_test.go Merge pull request #336 from libgit2/cmn/test-parallel Aug 27, 2016
branch.go Add check for ErrIterOver in BranchIterator.ForEach Sep 5, 2016
branch_test.go Run the tests in parallel Aug 27, 2016
checkout.go Removed Useless Argument Check Aug 28, 2016
cherrypick.go Cherrypick Mar 4, 2015
cherrypick_test.go Run the tests in parallel Aug 27, 2016
clone.go Clone Fix Jul 24, 2016
clone_test.go Run the tests in parallel Aug 27, 2016
commit.go Add method to fetch raw commit message Sep 9, 2016
config.go Merge remote-tracking branch 'upstream/master' into next Feb 15, 2016
config_test.go Run the tests in parallel Aug 27, 2016
credentials.go Add NewCredSshKeyFromMemory to the credentials helpers. Jun 22, 2016
describe.go Move from an Object interface to a type Aug 4, 2015
describe_test.go Update libgit2 to df4dfaad Jan 20, 2017
diff.go Merge remote-tracking branch 'upstream/master' into next Aug 27, 2016
diff_test.go Run the tests in parallel Aug 27, 2016
features.go Add Features() to retrieve the compile-time features of libgit2 Oct 31, 2016
git.go Update to 0.25-rc1 Nov 19, 2016
git_test.go Merge remote-tracking branch 'upstream/master' into next Aug 27, 2016
graph.go Remove "Graph" prefix on method names Feb 12, 2015
handles.go handles: use real pointers to keep track of handles Feb 18, 2016
ignore.go Add support for ignore Oct 20, 2015
index.go Implement git_index_remove_directory in index wrapper Oct 20, 2016
index_test.go Merge pull request #351 from ezwiebel/index-remove-directory Oct 31, 2016
merge.go Merge branch 'master' into next Feb 18, 2016
merge_test.go Run the tests in parallel Aug 27, 2016
note.go Create a NotesCollection for managing notes Jun 27, 2015
note_test.go Run the tests in parallel Aug 27, 2016
object.go Move from an Object interface to a type Aug 4, 2015
object_test.go Run the tests in parallel Aug 27, 2016
odb.go Merge remote-tracking branch 'origin/next' Jan 20, 2017
odb_test.go Run the tests in parallel Aug 27, 2016
packbuilder.go packbuilder: use HandleList for C function callbacks. May 22, 2015
patch.go Add missing thread-locking Dec 11, 2014
patch_test.go Run the tests in parallel Aug 27, 2016
push_test.go Run the tests in parallel Aug 27, 2016
refdb.go odb & refdb: make New*BackendFromC take unsafe.Pointer as argument al… Sep 30, 2016
reference.go Move from an Object interface to a type Aug 4, 2015
reference_test.go Run the tests in parallel Aug 27, 2016
remote.go Merge remote-tracking branch 'origin/next' Jan 20, 2017
remote_test.go Merge remote-tracking branch 'upstream/master' into next Aug 27, 2016
repository.go Merge remote-tracking branch 'upstream/master' into next Aug 27, 2016
reset.go ResetDefaultToCommit maps git_reset_default May 29, 2016
reset_test.go Run the tests in parallel Aug 27, 2016
revparse.go Move from an Object interface to a type Aug 4, 2015
revparse_test.go Run the tests in parallel Aug 27, 2016
settings.go Move the settings into the main git2go Jun 7, 2014
settings_test.go Move the settings into the main git2go Jun 7, 2014
signature.go Default signature Mar 4, 2015
stash.go Fix error after updating to latest changes Feb 20, 2016
stash_test.go Add stash support Sep 21, 2015
status.go StatusConflicted maps GIT_STATUS_CONFLICTED May 29, 2016
status_test.go Run the tests in parallel Aug 27, 2016
submodule.go Submodule: use the Repository constructor Jun 30, 2015
submodule_test.go Run the tests in parallel Aug 27, 2016
tag.go Tag Remove May 29, 2016
tag_test.go Run the tests in parallel Aug 27, 2016
tree.go Use Filemode in TreeBuilder.Insert, and add test coverage for some Feb 17, 2016
tree_test.go Run the tests in parallel Aug 27, 2016
walk.go Removes redundant iteration over check. Aug 29, 2016
wrapper.c Merge remote-tracking branch 'origin/next' Jan 20, 2017

README.md

git2go

GoDoc Build Status

Go bindings for libgit2.

Which branch to use

The numbered branches work against the version of libgit2 as specified by their number. You can import them in your project via gopkg.in, e.g. if you have libgit2 v0.25 installed you'd import with

import "gopkg.in/libgit2/git2go.v25"

which will ensure there are no sudden changes to the API.

The master branch follows the tip of libgit2 itself (with some lag) and as such has no guarantees on its own API nor does it have expectations the stability of libgit2's. Thus this only supports statically linking against libgit2.

Installing

This project wraps the functionality provided by libgit2. It thus needs it in order to perform the work.

This project wraps the functionality provided by libgit2. If you're using a versioned branch, install it to your system via your system's package manager and then install git2go.

Versioned branch, dynamic linking

When linking dynamically against a released version of libgit2, install it via your system's package manager. CGo will take care of finding its pkg-config file and set up the linking. Import via gopkg.in, e.g. to work against libgit2 v0.25

import "gopkg.in/libgit2/git2go.v25"

Master branch, or static linking

If using master or building a branch statically, we need to build libgit2 first. In order to build it, you need cmake, pkg-config and a C compiler. You will also need the development packages for OpenSSL (outside of Windows or macOS) and LibSSH2 installed if you want libgit2 to support HTTPS and SSH respectively. Note that even if libgit2 is included in the resulting binary, its dependencies will not be.

Run go get -d github.com/libgit2/git2go to download the code and go to your $GOPATH/src/github.com/libgit2/git2go directory. From there, we need to build the C code and put it into the resulting go binary.

git submodule update --init # get libgit2
make install

will compile libgit2, link it into git2go and install it.

Parallelism and network operations

libgit2 may use OpenSSL and LibSSH2 for performing encrypted network connections. For now, git2go asks libgit2 to set locking for OpenSSL. This makes HTTPS connections thread-safe, but it is fragile and will likely stop doing it soon. This may also make SSH connections thread-safe if your copy of libssh2 is linked against OpenSSL. Check libgit2's THREADSAFE.md for more information.

Running the tests

For the stable version, go test will work as usual. For the next branch, similarly to installing, running the tests requires building a local libgit2 library, so the Makefile provides a wrapper that makes sure it's built

make test

Alternatively, you can build the library manually first and then run the tests

./script/build-libgit2-static.sh
go test -v

License

M to the I to the T. See the LICENSE file if you've never seen a MIT license before.

Authors

  • Carlos Martín (@carlosmn)
  • Vicent Martí (@vmg)