summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorSanskar Jaiswal <[email protected]>2022-10-04 20:20:57 +0530
committerGitHub <[email protected]>2022-10-04 07:50:57 -0700
commitc1ec21d89caa0cdb0aefd6f6b8f95648418a3543 (patch)
tree33d4bb4b521a5c5f4502d92db478b0786953363b /README.md
parent9db5de109c166aa802b85cfae2dced3c4728a00d (diff)
libgit2 v1.5.0 #major (#929)
Update libgit2 to v1.5.0. Replace `SmartProxyOptions()` with `SmartRemoteConnectOptions()`. Fixes: https://github.com/libgit2/git2go/issues/899 Signed-off-by: Sanskar Jaiswal <[email protected]> Co-authored-by: lhchavez <[email protected]>
Diffstat (limited to 'README.md')
-rw-r--r--README.md15
1 files changed, 8 insertions, 7 deletions
diff --git a/README.md b/README.md
index 94fdab6..2816590 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
git2go
======
-[![GoDoc](https://godoc.org/github.com/libgit2/git2go?status.svg)](http://godoc.org/github.com/libgit2/git2go/v33) [![Build Status](https://travis-ci.org/libgit2/git2go.svg?branch=main)](https://travis-ci.org/libgit2/git2go)
+[![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)
Go bindings for [libgit2](http://libgit2.github.com/).
@@ -10,7 +10,8 @@ Due to the fact that Go 1.11 module versions have semantic meaning and don't nec
| libgit2 | git2go |
|---------|---------------|
-| main | (will be v34) |
+| main | (will be v35) |
+| 1.5 | v34 |
| 1.3 | v33 |
| 1.2 | v32 |
| 1.1 | v31 |
@@ -19,13 +20,13 @@ Due to the fact that Go 1.11 module versions have semantic meaning and don't nec
| 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 v33 with:
+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/v33
+go get github.com/libgit2/git2go/v34
```
```go
-import "github.com/libgit2/git2go/v33"
+import "github.com/libgit2/git2go/v34"
```
which will ensure there are no sudden changes to the API.
@@ -49,7 +50,7 @@ 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
```go
-import "github.com/libgit2/git2go/v33"
+import "github.com/libgit2/git2go/v34"
```
### Versioned branch, static linking
@@ -79,7 +80,7 @@ In order to let Go pass the correct flags to `pkg-config`, `-tags static` needs
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/v33 => ../../libgit2/git2go
+ replace github.com/libgit2/git2go/v34 => ../../libgit2/git2go
Parallelism and network operations
----------------------------------