jcarr
/
git2go
1
0
Fork 0
Code Issues 52 Pull Requests 31 Packages Projects Releases Wiki Activity

Merge branch 'devel'

This commit is contained in:
Jeff Carr 2024-12-17 15:02:44 -06:00
parent d5a0e0056f 585a8dbbe5
commit cf84056045
9 changed files with 22 additions and 74 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Build_bundled_static.go
View File

@ -11,7 +11,7 @@ package git
#include <git2.h> #include <git2.h>
#if LIBGIT2_VER_MAJOR != 1 || LIBGIT2_VER_MINOR < 5 || LIBGIT2_VER_MINOR > 5 #if LIBGIT2_VER_MAJOR != 1 || LIBGIT2_VER_MINOR < 5 || LIBGIT2_VER_MINOR > 5
# error "Invalid libgit2 version; this git2go supports libgit2 between v1.5.0 and v1.5.0" # error "Invalid libgit2 version; this libgit2 supports libgit2 between v1.5.0 and v1.5.0"
#endif #endif
*/ */
import "C" import "C"

2
Build_system_static.go
View File

@ -9,7 +9,7 @@ package git
#include <git2.h> #include <git2.h>
#if LIBGIT2_VER_MAJOR != 1 || LIBGIT2_VER_MINOR < 5 || LIBGIT2_VER_MINOR > 5 #if LIBGIT2_VER_MAJOR != 1 || LIBGIT2_VER_MINOR < 5 || LIBGIT2_VER_MINOR > 5
# error "Invalid libgit2 version; this git2go supports libgit2 between v1.5.0 and v1.5.0" # error "Invalid libgit2 version; this libgit2 supports libgit2 between v1.5.0 and v1.5.0"
#endif #endif
*/ */
import "C" import "C"

2
LICENSE
View File

@ -1,6 +1,6 @@
The MIT License The MIT License
Copyright (c) 2013 The git2go contributors Copyright (c) 2013 The libgit2 contributors
Permission is hereby granted, free of charge, to any person obtaining a copy Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal of this software and associated documentation files (the "Software"), to deal

3
Makefile
View File

@ -19,6 +19,9 @@ test:
install: install:
go install ./... go install ./...
clean:
rm go.*
# Bundled dynamic library # Bundled dynamic library
# ======================= # =======================
# In order to avoid having to manipulate `git_dynamic.go`, which would prevent # In order to avoid having to manipulate `git_dynamic.go`, which would prevent

77
README.md
View File

@ -1,11 +1,13 @@
git2go GO libgit2
====== ======
[![GoDoc](https://godoc.org/github.com/libgit2/git2go?status.svg)](http://godoc.org/github.com/libgit2/git2go/v34) [![Build Status](https://travis-ci.org/libgit2/git2go.svg?branch=main)](https://travis-ci.org/libgit2/git2go) [![GoDoc](https://godoc.org/go.wit.com/lib/libgit2?status.svg)](http://godoc.org/go.wit.com/lib/libgit2) [![Build Status](https://travis-ci.org/libgit2/libgit2.svg?branch=main)](https://travis-ci.org/libgit2/libgit2)
Go bindings for [libgit2](http://libgit2.github.com/). Go bindings for [libgit2](http://libgit2.github.com/).
### Updated 2024/12/16 ### Updated 2024/12/16
### Which Go version to use
* This package is updated to work against libgit2 version 1.8 on Debian sid * This package is updated to work against libgit2 version 1.8 on Debian sid
* There is one line commented out which needs to be fixed in remote.go * There is one line commented out which needs to be fixed in remote.go
* some of the tests seem to run * some of the tests seem to run
@ -13,48 +15,20 @@ Go bindings for [libgit2](http://libgit2.github.com/).
```sh ```sh
go install go.wit.com/apps/go-clone@latest go install go.wit.com/apps/go-clone@latest
go install go.wit.com/apps/go-mod-clean@latest go install go.wit.com/apps/go-mod-clean@latest
go-clone --recusive go.wit.com/lib/git2go go-clone --recusive go.wit.com/lib/libgit2
``` ```
### Which Go version to use
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:
| libgit2 | git2go |
|---------|---------------|
| main | (will be v35) |
| 1.5 | v34 |
| 1.3 | v33 |
| 1.2 | v32 |
| 1.1 | v31 |
| 1.0 | v30 |
| 0.99 | v29 |
| 0.28 | v28 |
| 0.27 | v27 |
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:
```sh
go get github.com/libgit2/git2go/v34
```
```go
import "github.com/libgit2/git2go/v34"
```
which will ensure there are no sudden changes to the API.
The `main` 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.
### Which branch to send Pull requests to ### Which branch to send Pull requests to
If there's something version-specific that you'd want to contribute to, you can send them to the `release-${MAJOR}.${MINOR}` branches, which follow libgit2's releases. TODO: not sure yet
Installing 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. 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. 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 libgit2.
### Versioned branch, dynamic linking ### Versioned branch, dynamic linking
@ -62,42 +36,13 @@ This project wraps the functionality provided by libgit2. If you're using a vers
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 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
```go ```go
import "github.com/libgit2/git2go/v34" goimports -w *.go
``` ```
### Versioned branch, static linking
Follow the instructions for [Versioned branch, dynamic linking](#versioned-branch-dynamic-linking), but pass the `-tags static,system_libgit2` flag to all `go` 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/...
### `main` branch, or vendored static linking
If using `main` or building a branch with the vendored libgit2 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 `main` 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 to `pkg-config`, `-tags static` needs to be passed to all `go` 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 the `pkg-config` file to be within the same directory where `make install-static` was called, so the `go.mod` file may need to have a [`replace` directive](https://github.com/golang/go/wiki/Modules#when-should-i-use-the-replace-directive) so that the correct setup is achieved. So if `git2go` is checked out at `$GOPATH/src/github.com/libgit2/git2go` and your project at `$GOPATH/src/github.com/my/project`, the `go.mod` file of `github.com/my/project` might need to have a line like
replace github.com/libgit2/git2go/v34 => ../../libgit2/git2go
Parallelism and network operations 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. libgit2 may use OpenSSL and LibSSH2 for performing encrypted network connections. For now, libgit2 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 Running the tests
----------------- -----------------
@ -119,6 +64,6 @@ M to the I to the T. See the LICENSE file if you've never seen an MIT license be
Authors Authors
------- -------
- Carlos Martín (@carlosmn) - Carlos Martín (github@carlosmn)
- Vicent Martí (@vmg) - Vicent Martí (github@vmg)

2
git.go
View File

@ -171,7 +171,7 @@ func initLibGit2() {
} }
// Shutdown frees all the resources acquired by libgit2. Make sure no // Shutdown frees all the resources acquired by libgit2. Make sure no
// references to any git2go objects are live before calling this. // references to any libgit2 go objects are live before calling this.
// After this is called, invoking any function from this library will result in // After this is called, invoking any function from this library will result in
// undefined behavior, so make sure this is called carefully. // undefined behavior, so make sure this is called carefully.
func Shutdown() { func Shutdown() {

2
http.go
View File

@ -103,7 +103,7 @@ func (t *httpSmartSubtransport) Action(url string, action SmartServiceAction) (S
return nil, err return nil, err
} }
req.Header.Set("User-Agent", "git/2.0 (git2go)") req.Header.Set("User-Agent", "git/2.0 (libgit2)")
stream := newManagedHttpStream(t, req) stream := newManagedHttpStream(t, req)
if req.Method == "POST" { if req.Method == "POST" {

2
script/install-libgit2.sh
View File

@ -1,7 +1,7 @@
#!/bin/sh #!/bin/sh
# #
# Install libgit2 to git2go in dynamic mode on Travis # Install libgit2 to go libgit2 in dynamic mode on Travis
# #
set -ex set -ex

4
transport.go
View File

@ -31,7 +31,7 @@ import (
) )
var ( var (
// globalRegisteredSmartTransports is a mapping of global, git2go-managed // globalRegisteredSmartTransports is a mapping of global, libgit2 go-managed
// transports. // transports.
globalRegisteredSmartTransports = struct { globalRegisteredSmartTransports = struct {
sync.Mutex sync.Mutex
@ -41,7 +41,7 @@ var (
} }
) )
// unregisterManagedTransports unregisters all git2go-managed transports. // unregisterManagedTransports unregisters all libgit2 go-managed transports.
func unregisterManagedTransports() error { func unregisterManagedTransports() error {
globalRegisteredSmartTransports.Lock() globalRegisteredSmartTransports.Lock()
originalTransports := globalRegisteredSmartTransports.transports originalTransports := globalRegisteredSmartTransports.transports