5 releases

0.0.6 Feb 17, 2023
0.0.5 Jan 3, 2023
0.0.4 Dec 5, 2022
0.0.3 Nov 28, 2022
0.0.2 Oct 19, 2022

#296 in Build Utils

Download history 3496/week @ 2024-10-26 4535/week @ 2024-11-02 4195/week @ 2024-11-09 3133/week @ 2024-11-16 2941/week @ 2024-11-23 3758/week @ 2024-11-30 3520/week @ 2024-12-07 4644/week @ 2024-12-14 1079/week @ 2024-12-21 1011/week @ 2024-12-28 2732/week @ 2025-01-04 3245/week @ 2025-01-11 3202/week @ 2025-01-18 3013/week @ 2025-01-25 3116/week @ 2025-02-01 3963/week @ 2025-02-08

13,953 downloads per month
Used in 96 crates (14 directly)

Apache-2.0

13KB
197 lines

crate-git-revision

Embed the git revision of a crate in its build.

Supports embedding the version from a local or remote git repository the build is occurring in, as well as when cargo install or depending on a crate published to crates.io.

It extracts the git revision in two ways:

  • From the .cargo_vcs_info.json file embedded in published crates.
  • From the git repository the build is occurring from in unpublished crates.

Injects an environment variable GIT_REVISION into the build that contains the full git revision, with a -dirty suffix if the working directory is dirty.

Requires the use of a build.rs build script. See Build Scripts for more details on how Rust build scripts work.

Examples

Add the following to the crate's Cargo.toml file:

[build_dependencies]
crate-git-revision = "0.0.2"

Add the following to the crate's build.rs file:

crate_git_revision::init();

Add the following to the crate's lib.rs or main.rs file:

pub const GIT_REVISION: &str = env!("GIT_REVISION");

License: Apache-2.0

Dependencies

~0.7–1.5MB
~33K SLoC