Skip to content

Commit 64d849b

Browse files
authored
Update to 1.4.1 (#811)
1 parent af6fc41 commit 64d849b

File tree

8 files changed

+42
-8
lines changed

8 files changed

+42
-8
lines changed

Diff for: CONTRIBUTING.md

+34
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Contributing
2+
3+
## Updating libgit2
4+
5+
The following steps can be used to update libgit2:
6+
7+
1. Update the submodule.
8+
There are several ways to go about this.
9+
One way is to go to the `libgit2-sys/libgit2` directory and run `git fetch origin` to download the latest updates, and then check out a specific tag (such as `git checkout v1.4.1`).
10+
2. Update all the references to the version:
11+
* Update [`libgit2-sys/build.rs`](https://github.com/rust-lang/git2-rs/blob/master/libgit2-sys/build.rs).
12+
There is a version probe (search for `cfg.atleast_version`) which should be updated.
13+
* Update the version in
14+
[`libgit2-sys/Cargo.toml`](https://github.com/rust-lang/git2-rs/blob/master/libgit2-sys/Cargo.toml).
15+
Update the metadata portion (the part after the `+`) to match libgit2.
16+
Also bump the Cargo version (the part before the `+`), keeping in mind
17+
if this will be a SemVer breaking change or not.
18+
* Update the dependency version in [`Cargo.toml`](https://github.com/rust-lang/git2-rs/blob/master/Cargo.toml) to match the version in the last step (do not include the `+` metadata).
19+
Also update the version of the `git2` crate itself so it will pick up the change to `libgit2-sys` (also keeping in mind if it is a SemVer breaking release).
20+
* Update the version in [`README.md`](https://github.com/rust-lang/git2-rs/blob/master/README.md) if needed.
21+
* If there was a SemVer-breaking version bump for either library, also update the `html_root_url` attribute in the `lib.rs` of each library.
22+
3. Run tests.
23+
`cargo test -p git2 -p git2-curl` is a good starting point.
24+
4. Run `systest`.
25+
This will validate for any C-level API problems.
26+
Unfortunately `systest` does not work on nightly, so you'll need to use stable.
27+
28+
`cargo +stable run -p systest`
29+
30+
The changelog at <https://github.com/libgit2/libgit2/blob/main/docs/changelog.md>
31+
can be helpful for seeing what has changed.
32+
The project has recently started labeling API and ABI breaking changes with labels:
33+
<https://github.com/libgit2/libgit2/pulls?q=is%3Apr+label%3A%22api+breaking%22%2C%22abi+breaking%22+is%3Aclosed>
34+
4. Once you have everything functional, publish a PR with the updates.

Diff for: Cargo.toml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "git2"
3-
version = "0.13.25"
3+
version = "0.14.0"
44
authors = ["Josh Triplett <[email protected]>", "Alex Crichton <[email protected]>"]
55
license = "MIT/Apache-2.0"
66
readme = "README.md"
@@ -20,7 +20,7 @@ url = "2.0"
2020
bitflags = "1.1.0"
2121
libc = "0.2"
2222
log = "0.4.8"
23-
libgit2-sys = { path = "libgit2-sys", version = "0.12.26" }
23+
libgit2-sys = { path = "libgit2-sys", version = "0.13.0" }
2424

2525
[target."cfg(all(unix, not(target_os = \"macos\")))".dependencies]
2626
openssl-sys = { version = "0.9.0", optional = true }

Diff for: README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ stable release as well.
1616

1717
## Version of libgit2
1818

19-
Currently this library requires libgit2 1.4.0. The source for libgit2 is
19+
Currently this library requires libgit2 1.4. The source for libgit2 is
2020
included in the libgit2-sys crate so there's no need to pre-install the libgit2
2121
library, the libgit2-sys crate will figure that and/or build that for you.
2222

Diff for: git2-curl/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ edition = "2018"
1616
curl = "0.4.33"
1717
url = "2.0"
1818
log = "0.4"
19-
git2 = { path = "..", version = "0.13", default-features = false }
19+
git2 = { path = "..", version = "0.14", default-features = false }
2020

2121
[dev-dependencies]
2222
civet = "0.11"

Diff for: libgit2-sys/Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[package]
22
name = "libgit2-sys"
3-
version = "0.12.26+1.4.0"
3+
version = "0.13.0+1.4.1"
44
authors = ["Josh Triplett <[email protected]>", "Alex Crichton <[email protected]>"]
55
links = "git2"
66
build = "build.rs"

Diff for: libgit2-sys/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
#![doc(html_root_url = "https://docs.rs/libgit2-sys/0.12")]
1+
#![doc(html_root_url = "https://docs.rs/libgit2-sys/0.13")]
22
#![allow(non_camel_case_types, unused_extern_crates)]
33

44
// This is required to link libz when libssh2-sys is not included.

Diff for: src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
//! source `Repository`, to ensure that they do not outlive the repository
6666
//! itself.
6767
68-
#![doc(html_root_url = "https://docs.rs/git2/0.13")]
68+
#![doc(html_root_url = "https://docs.rs/git2/0.14")]
6969
#![allow(trivial_numeric_casts, trivial_casts)]
7070
#![deny(missing_docs)]
7171
#![warn(rust_2018_idioms)]

0 commit comments

Comments
 (0)