Skip to content
Git to Go; bindings for libgit2. Like McDonald's but tastier.
Branch: master
Clone or download
carlosmn Merge pull request #479 from lhchavez/uprev-libgit2
Uprev vendored libgit2 to v.0.28
Latest commit bf1e8a4 Feb 15, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
script Improve the static build script Jan 5, 2019
vendor Uprev vendored libgit2 to v0.28 Feb 11, 2019
.gitignore
.gitmodules Remove left-over submodule configuration Jun 7, 2014
.travis.yml travis: let yaml know these strings are strings Mar 26, 2018
LICENSE
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 Remove uses of deprecated git_buf_free Aug 8, 2018
branch_test.go Run the tests in parallel Aug 27, 2016
checkout.go Fix typo in constant name Dec 17, 2018
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
commit.go Remove uses of deprecated git_buf_free Aug 8, 2018
config.go Remove unused parameter in OpenOndisk Dec 25, 2018
config_test.go Fixed issues with tests Dec 25, 2018
credentials.go Add NewCredSshKeyFromMemory to the credentials helpers. Jun 22, 2016
describe.go Remove uses of deprecated git_buf_free Aug 8, 2018
describe_test.go Update libgit2 to df4dfaad Jan 20, 2017
diff.go Remove uses of deprecated git_buf_free Aug 8, 2018
diff_test.go Run the tests in parallel Aug 27, 2016
features.go
git.go
git_dynamic.go Switch over the version contraints to v0.27 Feb 22, 2018
git_static.go
git_test.go Merge remote-tracking branch 'upstream/master' into next Aug 27, 2016
go.mod
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
index.go
index_test.go Bump vendored libgit2 to fba70a9d5f Jan 4, 2019
mempack.go Keep odb alive when adding mempack Jan 15, 2019
mempack_test.go Addressed review feedback and added a test Jan 8, 2019
merge.go Merge pull request #425 from josharian/more-merge-file-flags Jan 2, 2019
merge_test.go
note.go Remove uses of deprecated git_buf_free Aug 8, 2018
note_test.go Run the tests in parallel Aug 27, 2016
object.go Uprev vendored libgit2 to v0.28 Feb 11, 2019
object_test.go
odb.go Uprev vendored libgit2 to v0.28 Feb 11, 2019
odb_test.go Merge pull request #447 from walkenzoy/master Jan 3, 2019
packbuilder.go Add support for Packbuilder.InsertFromWalk() Nov 15, 2018
patch.go Remove uses of deprecated git_buf_free Aug 8, 2018
patch_test.go Run the tests in parallel Aug 27, 2016
push_test.go Run the tests in parallel Aug 27, 2016
rebase.go
rebase_test.go
refdb.go Third round of keep-alive aditions Jul 8, 2017
reference.go Use git_object_t instead of deprecated git_otype Jan 5, 2019
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
repository.go Merge remote-tracking branch 'upstream/master' into repository-create… Jan 8, 2019
repository_test.go Add a test and some comments as to the ugly pointer arithmetic Jan 8, 2019
reset.go ResetDefaultToCommit maps git_reset_default May 29, 2016
reset_test.go Clean up one leaked temporary directory Jan 5, 2019
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 Remove uses of deprecated git_buf_free Aug 8, 2018
settings_test.go Move the settings into the main git2go Jun 7, 2014
signature.go signature: improve Signature.Offset docs Jan 25, 2018
stash.go Third round of keep-alive aditions Jul 8, 2017
stash_test.go Add stash support Sep 21, 2015
status.go
status_test.go
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
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)
You can’t perform that action at this time.