6 releases

0.3.0 Apr 11, 2024
0.2.2 Mar 26, 2024
0.2.1 Sep 22, 2023
0.2.0 Mar 16, 2023
0.1.1 Mar 16, 2023

#1076 in Development tools

Download history 86/week @ 2024-07-19 143/week @ 2024-07-26 116/week @ 2024-08-02 48/week @ 2024-08-09 458/week @ 2024-08-16 104/week @ 2024-08-23 197/week @ 2024-08-30 173/week @ 2024-09-06 51/week @ 2024-09-13 159/week @ 2024-09-20 171/week @ 2024-09-27 154/week @ 2024-10-04 174/week @ 2024-10-11 157/week @ 2024-10-18 29/week @ 2024-10-25 106/week @ 2024-11-01

500 downloads per month

MIT license

40KB
948 lines

ci_env

Crates.io Crates.io

Detects CI (continuous integration) information from the current environment.

Usage

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.

Dependencies

~0.3–1MB
~21K SLoC