Repository files navigation

Go bindings forlibgit2.

Due to the fact that Go 1.11 module versions have semantic meaning and don't necessarily align with libgit2's release schedule, please consult the following table for a mapping between libgit2 and git2go module versions:

You can import them in your project with the version's major number as a suffix. For example, if you have libgit2 v1.2 installed, you'd import git2go v34 with:

go get github.com/libgit2/git2go/v34

import"github.com/libgit2/git2go/v34"

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

Themain branch follows the tip of libgit2 itself (with some lag) and as such has no guarantees on the stability of libgit2's API. Thus this only supports statically linking against libgit2.

If there's something version-specific that you'd want to contribute to, you can send them to therelease-${MAJOR}.${MINOR} branches, which follow libgit2's releases.

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.

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 Go modules, e.g. to work against libgit2 v1.2

import"github.com/libgit2/git2go/v34"

Follow the instructions forVersioned branch, dynamic linking, but pass the-tags static,system_libgit2 flag to allgo commands that build any binaries. For instance:

go build -tags static,system_libgit2 github.com/my/project/...go test -tags static,system_libgit2 github.com/my/project/...go install -tags static,system_libgit2 github.com/my/project/...

If usingmain or building a branch with the vendored libgit2 statically, we need to build libgit2 first. In order to build it, you needcmake,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.

Rungo 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 libgit2make install-static

will compile libgit2, link it into git2go and install it. Themain 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.

In order to let Go pass the correct flags topkg-config,-tags static needs to be passed to allgo commands that build any binaries. For instance:

go build -tags static github.com/my/project/...go test -tags static github.com/my/project/...go install -tags static github.com/my/project/...

One thing to take into account is that since Go expects thepkg-config file to be within the same directory wheremake install-static was called, so thego.mod file may need to have areplace directive so that the correct setup is achieved. So ifgit2go is checked out at$GOPATH/src/github.com/libgit2/git2go and your project at$GOPATH/src/github.com/my/project, thego.mod file ofgithub.com/my/project might need to have a line like

replace github.com/libgit2/git2go/v34 => ../../libgit2/git2go

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'sTHREADSAFE.md for more information.

For the stable version,go test will work as usual. For themain 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

make install-staticgo test -v -tags static ./...

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

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