shipper-cli 0.4.0

CLI adapter for Shipper; install the user-facing `shipper` package unless embedding the adapter.
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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76

//! Git working-tree context probe.

use shipper_core::plan;

use crate::doctor::findings::{Finding, FindingLevel};

#[derive(Debug, serde::Serialize)]
pub(in crate::doctor) struct GitCheck {
    pub is_repository: bool,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub commit: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub branch: Option<String>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub dirty: Option<bool>,
    pub findings: Vec<Finding>,
}

pub(in crate::doctor) fn check(ws: &plan::PlannedWorkspace) -> Vec<Finding> {
    let check = inspect(ws);
    if check.is_repository {
        println!(
            "git_commit: {}",
            check.commit.clone().unwrap_or_else(|| "-".into())
        );
        println!(
            "git_branch: {}",
            check.branch.clone().unwrap_or_else(|| "-".into())
        );
        println!("git_dirty: {}", check.dirty.unwrap_or(false));
    } else {
        println!("git_context: not a git repository");
    }
    check.findings
}

pub(in crate::doctor) fn inspect(ws: &plan::PlannedWorkspace) -> GitCheck {
    let mut findings = Vec::new();

    match shipper_core::git::collect_git_context_at(&ws.workspace_root) {
        Some(git) => {
            let dirty = git.dirty.unwrap_or(false);
            if dirty {
                findings.push(Finding {
                    id: "git-working-tree-dirty",
                    severity: FindingLevel::Blocked,
                    status: FindingLevel::Blocked,
                    title: "git working tree is dirty",
                    why_it_matters:
                        "release evidence must describe the exact source tree being planned, proven, published, and resumed",
                    evidence: "git_dirty: true".to_string(),
                    try_next: vec![
                        "commit, stash, or revert unrelated changes before release",
                        "rerun `shipper doctor` and `shipper preflight`",
                        "use `--allow-dirty` only for intentional local rehearsal",
                    ],
                    docs: Some("docs/failure-modes.md"),
                });
            }
            GitCheck {
                is_repository: true,
                commit: git.commit,
                branch: git.branch,
                dirty: Some(dirty),
                findings,
            }
        }
        None => GitCheck {
            is_repository: false,
            commit: None,
            branch: None,
            dirty: None,
            findings,
        },
    }
}