vership 0.5.0

Multi-target release orchestrator
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
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

use std::path::Path;
use std::process::Command;

use crate::error::{Error, Result};
use crate::git;
use crate::output;
use crate::project::ProjectType;

pub struct CheckOptions {
    pub expected_branch: String,
    pub run_lint: bool,
    pub run_tests: bool,
    pub lint_command: Option<String>,
    pub test_command: Option<String>,
    /// When true, skip the "no uncommitted changes" check. Used when resuming
    /// an interrupted release where version files were already bumped.
    pub allow_uncommitted: bool,
}

impl Default for CheckOptions {
    fn default() -> Self {
        Self {
            expected_branch: "main".to_string(),
            run_lint: true,
            run_tests: true,
            lint_command: None,
            test_command: None,
            allow_uncommitted: false,
        }
    }
}

/// Run all pre-flight checks. Returns Ok(()) if all pass.
pub fn run_preflight(
    root: &Path,
    tag: &str,
    project: &dyn ProjectType,
    options: &CheckOptions,
) -> Result<()> {
    // No uncommitted changes (skipped when resuming an interrupted release)
    if options.allow_uncommitted {
        output::print_check_pass("Uncommitted changes allowed (resuming interrupted release)");
    } else if git::has_uncommitted_changes(root)? {
        output::print_check_fail("Uncommitted changes detected");
        return Err(Error::CheckFailed(
            "commit or stash your changes before releasing".to_string(),
        ));
    } else {
        output::print_check_pass("No uncommitted changes");
    }

    // On expected branch
    let branch = git::current_branch(root)?;
    if branch != options.expected_branch {
        output::print_check_fail(&format!(
            "On branch '{branch}', expected '{}'",
            options.expected_branch
        ));
        return Err(Error::CheckFailed(format!(
            "switch to '{}' branch before releasing",
            options.expected_branch
        )));
    }
    output::print_check_pass(&format!("On branch {branch}"));

    // Tag does not already exist
    if git::tag_exists(root, tag)? {
        output::print_check_fail(&format!("Tag {tag} already exists"));
        return Err(Error::CheckFailed(format!("tag {tag} already exists")));
    }
    output::print_check_pass(&format!("Tag {tag} does not exist"));

    // Lock file in sync
    match project.verify_lockfile(root) {
        Ok(()) => output::print_check_pass("Lock file in sync"),
        Err(e) => {
            output::print_check_fail("Lock file out of sync");
            return Err(e);
        }
    }

    // Lint (skippable)
    if options.run_lint {
        let result = if let Some(cmd) = &options.lint_command {
            run_shell_command(root, cmd)
        } else {
            project.run_lint(root)
        };
        match result {
            Ok(()) => output::print_check_pass("Lint passes"),
            Err(_) => {
                output::print_check_fail("Lint failed");
                return Err(Error::CheckFailed("lint checks failed".to_string()));
            }
        }
    }

    // Tests (skippable)
    if options.run_tests {
        let result = if let Some(cmd) = &options.test_command {
            run_shell_command(root, cmd)
        } else {
            project.run_tests(root)
        };
        match result {
            Ok(()) => output::print_check_pass("Tests pass"),
            Err(_) => {
                output::print_check_fail("Tests failed");
                return Err(Error::CheckFailed("tests failed".to_string()));
            }
        }
    }

    Ok(())
}

fn run_shell_command(root: &Path, cmd: &str) -> Result<()> {
    let status = Command::new("sh")
        .args(["-c", cmd])
        .current_dir(root)
        .stdout(std::process::Stdio::null())
        .stderr(std::process::Stdio::null())
        .status()
        .map_err(|e| Error::Other(format!("run command '{cmd}': {e}")))?;
    if status.success() {
        Ok(())
    } else {
        Err(Error::CheckFailed(format!("command failed: {cmd}")))
    }
}