rust-clippy/rustc_tools_util
Cameron Steffen 7dd356d9f1 Eat dogfood
2021-05-26 16:53:13 -05:00
..
src Eat dogfood 2021-05-26 16:53:13 -05:00
Cargo.toml Set Clippy authors to "The Rust Clippy Developers" 2021-03-09 17:50:04 +01:00
LICENSE-APACHE To make it easier for Linux distributions, ship the licenses text within 2020-05-25 23:06:08 +02:00
LICENSE-MIT To make it easier for Linux distributions, ship the licenses text within 2020-05-25 23:06:08 +02:00
README.md Update Copyright year 2020-02-20 12:06:45 +01:00

rustc_tools_util

A small tool to help you generate version information for packages installed from a git repo

Usage

Add a build.rs file to your repo and list it in Cargo.toml

build = "build.rs"

List rustc_tools_util as regular AND build dependency.

[dependencies]
rustc_tools_util = "0.1"

[build-dependencies]
rustc_tools_util = "0.1"

In build.rs, generate the data in your main()

fn main() {
    println!(
        "cargo:rustc-env=GIT_HASH={}",
        rustc_tools_util::get_commit_hash().unwrap_or_default()
    );
    println!(
        "cargo:rustc-env=COMMIT_DATE={}",
        rustc_tools_util::get_commit_date().unwrap_or_default()
    );
    println!(
        "cargo:rustc-env=RUSTC_RELEASE_CHANNEL={}",
        rustc_tools_util::get_channel().unwrap_or_default()
    );
}

Use the version information in your main.rs

use rustc_tools_util::*;

fn show_version() {
    let version_info = rustc_tools_util::get_version_info!();
    println!("{}", version_info);
}

This gives the following output in clippy: clippy 0.0.212 (a416c5e 2018-12-14)

License

Copyright 2014-2020 The Rust Project Developers

Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0> or the MIT license <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your option. All files in the project carrying such notice may not be copied, modified, or distributed except according to those terms.