Skip to content

Latest commit

 

History

History
108 lines (69 loc) · 3.03 KB

README.md

File metadata and controls

108 lines (69 loc) · 3.03 KB
Raw

LibGit2Sharp.NativeBinaries

Libgit2Sharp is a managed wrapper around libgit2, and as such requires compilation of libgit2 for your platform.

LibGit2Sharp makes this easy by distributing, and leveraging as a dependency, the LibGit2Sharp.NativeBinaries NuGet package.

This package contains the compiled versions of the libgit2 native library for the following platforms:

  • Windows (x86, x64, arm64)
  • macOS (x64, arm64)
  • Linux
    • glibc: (x64, arm, arm64, ppc64le)
    • musl: (x64, arm, arm64)

Script overview

The following scripts are used to build libgit2 and update this repo.

build.libgit2.ps1

This script builds Windows libgit2 binaries. It requires Visual Studio 2019 to run.

To build x86 binaries:

build.libgit2.ps1 -x86

To build x64 binaries:

build.libgit2.ps1 -x64

To build arm64 binaries:

build.libgit2.ps1 -arm64

Multiple architecture parameters can be specified to build multiple binaries with a single execution of the script.

See the script for additional parameters.

build.libgit2.sh

This script builds Linux and macOS binaries. It can be invoked directly, but for Linux binaries, dockerbuild.sh should be used instead.

dockerbuild.sh

This script will build one of the Dockerfiles in the repo. It chooses which one to run based on the value of the RID environment variable. Using docker to build the Linux binaries for the various RIDs ensures that a specific environment and distro is used.

UpdateLibgit2ToSha.ps1

This script is used to update the libgit2 submodule and update the references within the project to the correct libgit2 revision.

You can update to a specific commit:

UpdateLibgit2ToSha.ps1 1a2b3c4

Or you can specify references:

UpdateLibgit2ToSha.ps1 master

Building the package locally

After running the appropriate build script(s) to create binaries, the NuGet package needs to be created.

First, to use the same version locally that will be generated via CI, install the minver-cli dotnet tool:

dotnet tool install --global minver-cli

Once that is installed, running the minver command will output a version:

MinVer: Using { Commit: 2453a6d, Tag: '2.0.312', Version: 2.0.312, Height: 3 }.
MinVer: Calculated version 2.0.313-alpha.0.3.
2.0.313-alpha.0.3

To create the package, use the the following command:

nuget.exe Pack nuget.package/NativeBinaries.nuspec -Version <version> -NoPackageAnalysis

Where <version> is the version from the MinVer tool or manually chosen version.

Notes on Visual Studio

Visual Studio 2019 is required to build the Windows native binaries, however you do not need to install a paid version of Visual Studio. libgit2 can be compiled using Visual Studio Community, which is free for building open source applications.