ci_env 0.4.1

Detect CI information from the environment.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37

use crate::api::{opt_var, var, CiEnvironment, CiOutput, CiProvider};

// https://docs.github.com/en/actions/using-workflows/workflow-commands-for-github-actions#grouping-log-lines
pub const GITHUB_OUTPUT: CiOutput = CiOutput {
    close_log_group: "::endgroup::",
    open_log_group: "::group::{name}",
};

// https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
pub fn create_environment() -> CiEnvironment {
    let ref_path = var("GITHUB_REF");

    // GITHUB_HEAD_SHA and GITHUB_PULL_REQUEST are non-standard
    CiEnvironment {
        base_branch: opt_var("GITHUB_BASE_REF"),
        base_revision: None,
        branch: opt_var("GITHUB_HEAD_REF")
            .or_else(|| opt_var("GITHUB_REF_NAME"))
            .unwrap_or_default(),
        env_prefix: Some("GITHUB_".into()),
        head_revision: None,
        id: var("GITHUB_RUN_ID"),
        provider: CiProvider::GithubActions,
        request_id: opt_var("GITHUB_PULL_REQUEST").or_else(|| {
            if ref_path.starts_with("refs/pull") {
                Some(ref_path.replace("refs/pull/", "").replace("/merge", ""))
            } else {
                None
            }
        }),
        request_url: None,
        revision: opt_var("GITHUB_HEAD_SHA")
            .or_else(|| opt_var("GITHUB_SHA"))
            .unwrap_or_default(),
        url: None,
    }
}