ci_info

Provides current CI environment information.

Overview

This library main goal is to provide development/build tools such as cargo-make the needed information on the current CI environment.
Inspired by the ci-info npm module.

Usage

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

Fetching Info

```rust fn main() { // Just check if a CI environment is detected. let ci = ciinfo::isci(); println!("Is CI: {}", ci);

// Get CI environment information
let info = ci_info::get();
println!("Is CI: {}", info.ci);
if let Some(vendor) = info.vendor {
    println!("Vendor: {:#?}", vendor);
    println!("Name: {:#?}", info.name.unwrap());
}
if let Some(pr) = info.pr {
    println!("Is PR: {:#?}", pr);
}
if let Some(branch_name) = info.branch_name {
    println!("Branch Name: {:#?}", branch_name);
}

} ```

Mocking CI environment

```rust use ci_info::types::{CiInfo, Vendor};

fn main() { // create the CI info manually let mut mockinfo = CiInfo::new(); mockinfo.vendor = Some(Vendor::TravisCI); mockinfo.ci = true; mockinfo.pr = Some(true); mockinfo.branchname = Some("devbranch".tostring());

// 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

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

ini [dependencies] ci_info = "^0.14.2"

There is optional serde support that can be enabled via the serde-1 feature:

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

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.