Crates.io | ci_env |
lib.rs | ci_env |
version | 0.3.0 |
source | src |
created_at | 2023-03-16 20:49:48.3124 |
updated_at | 2024-04-11 00:00:58.811992 |
description | Detect CI information from the environment. |
homepage | https://github.com/milesj/rust-cicd-env |
repository | https://github.com/milesj/rust-cicd-env |
max_upload_size | |
id | 812066 |
size | 39,562 |
Detects CI (continuous integration) information from the current environment.
To start, detect if in a CI environment.
ci_env::is_ci();
Or detect which CI provider is being used.
ci_env::detect_provider(); // GithubActions
And most importantly, extract information about the CI environment and CI provider. This includes branch, commit, and pull request information.
use ci_env::get_environment;
if let Some(ci) = get_environment() {
println!("Provider: {:?}", ci.provider);
println!("Branch: {}", ci.branch);
println!("Commit: {}", ci.revision);
if let Some(pr_number) = ci.request_id {
println!("PR #: {}", pr_number);
}
}
This library will properly take into account source and target branches when a pull request is involved. Do note though that not all providers provide this information.