git2-rs

libgit2 bindings for Rust

[dependencies]git2 = "0.13"

Rust version requirements

git2-rs works with stable Rust, and typically works with the most recent priorstable release as well. Check the MSRV job of the CI script to see the oldestversion of Rust known to pass tests.

Version of libgit2

Currently this library requires libgit2 1.0.0. The source for libgit2 isincluded in the libgit2-sys crate so there's no need to pre-install the libgit2library, the libgit2-sys crate will figure that and/or build that for you.

Building git2-rs

$ git clone https://github.com/rust-lang/git2-rs$ cd git2-rs$ cargo build

Automating Testing

Running tests and handling all of the associated edge cases on every commitproves tedious very quickly. To automate tests and handle proper stashing andunstashing of unstaged changes and thus avoid nasty surprises, use thepre-commit hook found here and place it into the.git/hooks/ with the name pre-commit. You may need to add executionpermissions with chmod +x.

To skip tests on a simple commit or doc-fixes, use git commit --no-verify.

Building on OSX 10.10+

If the ssh feature is enabled (and it is by default) then this library dependson libssh2 which depends on OpenSSL. To get OpenSSL working follow theopenssl crate's instructions.

License

This project is licensed under either of

Apache License, Version 2.0, (LICENSE-APACHE orhttp://www.apache.org/licenses/LICENSE-2.0)
MIT license (LICENSE-MIT orhttp://opensource.org/licenses/MIT)

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submittedfor inclusion in git2-rs by you, as defined in the Apache-2.0 license, shall bedual licensed as above, without any additional terms or conditions.