Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sagiegurari/ci_info
Provides current CI environment information.
https://github.com/sagiegurari/ci_info
appveyor build build-automation ci continuous-integration rust rust-library travis travis-ci
Last synced: about 2 months ago
JSON representation
Provides current CI environment information.
- Host: GitHub
- URL: https://github.com/sagiegurari/ci_info
- Owner: sagiegurari
- License: apache-2.0
- Created: 2017-10-10T16:09:20.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2024-01-13T16:36:30.000Z (12 months ago)
- Last Synced: 2024-04-24T15:23:51.396Z (8 months ago)
- Topics: appveyor, build, build-automation, ci, continuous-integration, rust, rust-library, travis, travis-ci
- Language: Rust
- Homepage:
- Size: 4.57 MB
- Stars: 14
- Watchers: 3
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ci_info
[](https://crates.io/crates/ci_info) [](https://github.com/sagiegurari/ci_info/actions) [](https://codecov.io/gh/sagiegurari/ci_info)
[](https://github.com/sagiegurari/ci_info/blob/master/LICENSE) [](https://libraries.io/cargo/ci_info) [](https://docs.rs/crate/ci_info/) [](https://crates.io/crates/ci_info)
[](https://sagiegurari.github.io/cargo-make)
> Provides current CI environment information.
* [Overview](#overview)
* [Usage](#usage)
* [Installation](#installation)
* [API Documentation](https://sagiegurari.github.io/ci_info/)
* [Contributing](.github/CONTRIBUTING.md)
* [Release History](CHANGELOG.md)
* [License](#license)
## Overview
This library main goal is to provide development/build tools such as [cargo-make](https://sagiegurari.github.io/cargo-make/) the needed information on the current CI environment.
Inspired by the [ci-info](https://github.com/watson/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 = 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);
}
}
```
### Mocking CI environment
```rust
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);
}
```
## Installation
In order to use this library, just add it as a dependency:
```ini
[dependencies]
ci_info = "^0.14.14"
```
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](https://sagiegurari.github.io/ci_info/)
## Contributing
See [contributing guide](.github/CONTRIBUTING.md)
See [Changelog](CHANGELOG.md)
## License
Developed by Sagie Gur-Ari and licensed under the Apache 2 open source license.