ci_info

提供当前CI环境信息。

• 概述
• 用法
• 安装
• API文档
• 贡献
• 版本历史
• 许可

概述

这个库的主要目标是向开发/构建工具（如 cargo-make）提供关于当前CI环境的必要信息。
受到 ci-info npm模块的启发。

用法

只需包含该库并调用get函数即可拉取所有信息，如下所示

获取信息

fn main() {
    // Just check if a CI environment is detected.
    let ci = ci_info::is_ci();
    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);
    }
}

模拟CI环境

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

fn main() {
    // create the CI info manually
    let mut 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);
}

安装

为了使用此库，只需将其作为依赖项添加

[dependencies]
ci_info = "^0.14.14"

存在可选的 serde 支持，可以通过 serde-1 功能启用

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

API文档

请参阅完整的文档：API文档

贡献

请参阅 贡献指南

版本历史

请参阅 变更日志

许可

由Sagie Gur-Ari开发，并许可在Apache 2开源许可下。