Overview

Usage

Fetching Info

fnmain(){// Just check if a CI environment is detected.let ci = ci_info::is_ci();println!("Is CI: {}", ci);// Get CI environment informationlet info = ci_info::get();println!("Is CI: {}", info.ci);ifletSome(vendor) = info.vendor{println!("Vendor: {:#?}", vendor);println!("Name: {:#?}", info.name.unwrap());}ifletSome(pr) = info.pr{println!("Is PR: {:#?}", pr);}ifletSome(branch_name) = info.branch_name{println!("Branch Name: {:#?}", branch_name);}}

Mocking CI environment

use ci_info::types::{CiInfo,Vendor};fnmain(){// create the CI info manuallyletmut mock_info =CiInfo::new();    mock_info.vendor =Some(Vendor::TravisCI);    mock_info.ci =true;    mock_info.pr =Some(true);    mock_info.branch_name =Some("dev_branch".to_string());// mock environment    ci_info::mock_ci(&mock_info);let info = ci_info::get();assert!(info.ci);assert!(info.pr.unwrap());assert_eq!(info.vendor.unwrap(),Vendor::TravisCI);assert_eq!(info.name.unwrap(),"Travis CI");assert_eq!(info.branch_name.unwrap(),"dev_branch");// clear CI environment    mock_info =CiInfo::new();    ci_info::mock_ci(&mock_info);let info = ci_info::get();assert!(!info.ci);}

Installation

[dependencies]ci_info ="^0.14.14"

[dependencies]ci_info = {version ="*",features = ["serde-1"] }

API Documentation

Contributing

Release History

License