git_info

Crates.iogit_info
lib.rsgit_info
version0.1.3
sourcesrc
created_at2019-11-27 19:49:38.418046
updated_at2024-08-30 12:22:54.251362
descriptionExtracts git repository information.
homepagehttp://github.com/sagiegurari/git_info
repositoryhttps://github.com/sagiegurari/git_info.git
max_upload_size
id184915
size1,405,971
CrateOwner (github:gigainfosystems:crateowner)

documentation

https://sagiegurari.github.io/git_info/api/git_info/index.html

README

git_info

crates.io CI codecov
license Libraries.io for GitHub Documentation downloads
Built with cargo-make

Extracts git repository information.

Overview

This library main goal is to provide development/build tools such as cargo-make the needed information on the current git repository.

Usage

Simply include the library and invoke the get function to pull all info as follows:

fn main() {
    let info = git_info::get();

    println!(
        "User Name: {}",
        info.user_name.unwrap_or("Unknown".to_string())
    );
    println!(
        "User Email: {}",
        info.user_email.unwrap_or("Unknown".to_string())
    );
    println!("Dirty: {}", info.dirty.unwrap_or(false));
    println!(
        "Current Branch: {}",
        info.current_branch.unwrap_or("Unknown".to_string())
    );

    println!(
        "Last Commit Hash: {}",
        info.head.last_commit_hash.unwrap_or("Unknown".to_string())
    );
    println!(
        "Last Commit Hash (short): {}",
        info.head
            .last_commit_hash_short
            .unwrap_or("Unknown".to_string())
    );

    println!("Config: {:#?}", info.config.unwrap());
    println!("Branches: {:#?}", info.branches.unwrap_or(vec![]));
}

Installation

In order to use this library, just add it as a dependency:

[dependencies]
git_info = "^0.1.3"

API Documentation

See full docs at: API Docs

Contributing

See contributing guide

Release History

See Changelog

License

Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license.

Commit count: 59

cargo fmt