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

#526 in Development tools

Download history 147/week @ 2024-01-25 261/week @ 2024-02-01 162/week @ 2024-02-08 125/week @ 2024-02-15 171/week @ 2024-02-22 211/week @ 2024-02-29 200/week @ 2024-03-07 185/week @ 2024-03-14 391/week @ 2024-03-21 202/week @ 2024-03-28 235/week @ 2024-04-04 410/week @ 2024-04-11 232/week @ 2024-04-18 142/week @ 2024-04-25 82/week @ 2024-05-02 54/week @ 2024-05-09

578 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.5–1MB
~24K SLoC