libgit2 bindings for Rust
[dependencies] git2 = "0.8"
Rust version requirements
git2-rs works with stable Rust, and typically works with the most recent prior stable release as well. Check azure-pipelines.yml to see the oldest version of Rust known to pass tests.
Version of libgit2
Currently this library requires libgit2 0.28.0. The source for libgit2 is included in the libgit2-sys crate so there's no need to pre-install the libgit2 library, the libgit2-sys crate will figure that and/or build that for you.
$ git clone https://github.com/rust-lang/git2-rs $ cd git2-rs $ cargo build
Running tests and handling all of the associated edge cases on every commit
proves tedious very quickly. To automate tests and handle proper stashing and
unstashing of unstaged changes and thus avoid nasty surprises, use the
pre-commit hook found here and place it into the
.git/hooks/ with the name
pre-commit. You may need to add execution
To skip tests on a simple commit or doc-fixes, use
git commit --no-verify.
Building on OSX 10.10+
ssh feature is enabled (and it is by default) then this library depends
on libssh2 which depends on OpenSSL. To get OpenSSL working follow the
openssl crate's instructions.
This project is licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in git2-rs by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.