Git to Go; bindings for libgit2. Like McDonald's but tastier.
Go C Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
script Get rid of the with-static.sh script Oct 31, 2016
vendor vendor: update libgit2 to v0.27.0 Mar 26, 2018
.gitmodules Remove left-over submodule configuration Jun 7, 2014
.travis.yml travis: let yaml know these strings are strings Mar 26, 2018
LICENSE Initial commit Mar 5, 2013
Makefile Deduplicate Makefile static target and add thread locking check Jul 8, 2017
README.md README: correct the branches in the testing block Oct 16, 2017
blame.go First round of mass keep-alive additions Jul 8, 2017
blame_test.go Run the tests in parallel Aug 27, 2016
blob.go fixed typos Jul 12, 2017
blob_test.go Merge pull request #336 from libgit2/cmn/test-parallel Aug 27, 2016
branch.go First round of mass keep-alive additions Jul 8, 2017
branch_test.go Run the tests in parallel Aug 27, 2016
checkout.go First round of mass keep-alive additions Jul 8, 2017
cherrypick.go First round of mass keep-alive additions Jul 8, 2017
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 Objecer interface Jul 8, 2017
config.go Bump libgit2 to f1323d9c Jan 17, 2018
config_test.go Fix a couple of issues reported by go-vet Jul 6, 2017
credentials.go Add NewCredSshKeyFromMemory to the credentials helpers. Jun 22, 2016
describe.go First round of mass keep-alive additions Jul 8, 2017
describe_test.go Update libgit2 to df4dfaad Jan 20, 2017
diff.go diff: add two missing options Jan 17, 2018
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 Second round of keep-alives Jul 8, 2017
git_dynamic.go Switch over the version contraints to v0.27 Feb 22, 2018
git_static.go Switch over the version contraints to v0.27 Feb 22, 2018
git_test.go Merge remote-tracking branch 'upstream/master' into next Aug 27, 2016
graph.go Second round of keep-alives Jul 8, 2017
handles.go handles: use real pointers to keep track of handles Feb 18, 2016
ignore.go Second round of keep-alives Jul 8, 2017
index.go Second round of keep-alives Jul 8, 2017
index_test.go Merge pull request #351 from ezwiebel/index-remove-directory Oct 31, 2016
merge.go merge: expose the conflict marker size option Feb 22, 2018
merge_test.go Run the tests in parallel Aug 27, 2016
note.go Third round of keep-alive aditions Jul 8, 2017
note_test.go Run the tests in parallel Aug 27, 2016
object.go Add Objecer interface Jul 8, 2017
object_test.go fixed typos Jul 12, 2017
odb.go Adjust to the change in the git_odb_open_rstream signature Feb 22, 2018
odb_test.go Run the tests in parallel Aug 27, 2016
packbuilder.go Third round of keep-alive aditions Jul 8, 2017
patch.go patch: adjust to new function signature Sep 29, 2017
patch_test.go Run the tests in parallel Aug 27, 2016
push_test.go Run the tests in parallel Aug 27, 2016
rebase.go Fix typo in the error message Oct 2, 2017
rebase_test.go rebase: correct the return values for CurrentOperationIndex Jul 8, 2017
refdb.go Third round of keep-alive aditions Jul 8, 2017
reference.go reference: minor doc improvements Feb 15, 2018
reference_test.go Run the tests in parallel Aug 27, 2016
remote.go remote: add keep-alive and references to the repository Jul 4, 2017
remote_test.go Merge remote-tracking branch 'upstream/master' into next Aug 27, 2016
repository.go fixed typos Jul 12, 2017
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 Third round of keep-alive aditions Jul 8, 2017
stash.go Third round of keep-alive aditions Jul 8, 2017
stash_test.go Add stash support Sep 21, 2015
status.go Third round of keep-alive aditions Jul 8, 2017
status_test.go Run the tests in parallel Aug 27, 2016
submodule.go clone_checkout_strategy removed Sep 3, 2017
submodule_test.go Run the tests in parallel Aug 27, 2016
tag.go tag: accept an Objecter for creating a tag Jul 8, 2017
tag_test.go Run the tests in parallel Aug 27, 2016
tree.go tree: keep tree receiver alive as long as dependent entry is used Feb 9, 2018
tree_test.go Run the tests in parallel Aug 27, 2016
walk.go Third round of keep-alive aditions Jul 8, 2017
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-static

will compile libgit2, link it into git2go and install it. The master branch is set up to follow the specific libgit2 version that is vendored, so trying dynamic linking may or may not work depending on the exact versions involved.

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 master 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-static

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

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

License

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

Authors

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