mise 2026.9.3

Dev tools, env vars, and tasks in one CLI
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

//! The explicit versioned marker of a history-enabled setup repository:
//! `.mise-history/format.toml` with `format = 1`. A repository without it is
//! an ordinary repository and keeps its old `--from`/`--adopt`
//! behaviour; a newer format stops with an upgrade message.

use eyre::{Result, bail};
use serde::Deserialize;

use super::layout::MARKER_PATH;
use crate::system::history::shadow::HistoryRepo;

pub(crate) const FORMAT: u32 = 1;

#[derive(Deserialize)]
struct Marker {
    format: u32,
}

pub(crate) fn marker_content() -> String {
    format!(
        "# This repository is a mise setup repository (`mise bootstrap dotfiles origin set`).\n# Do not edit: mise reads this to recognize the layout it publishes.\nformat = {FORMAT}\n"
    )
}

pub(crate) fn parse_marker(bytes: &[u8]) -> Result<u32> {
    let text = String::from_utf8_lossy(bytes);
    let marker: Marker = toml::from_str(&text)?;
    Ok(marker.format)
}

/// What the fetched setup branch is.
#[derive(Clone, Debug, PartialEq, Eq)]
pub(crate) enum RepoState {
    /// No branch yet: the first publication creates it with the marker.
    Empty,
    /// A history-enabled repository of the given format.
    Marked(u32),
    /// An existing, non-empty repository without the marker: adopted only
    /// after a deliberate confirmation.
    Unmarked,
}

impl RepoState {
    /// Fails for a format this mise does not understand.
    pub(crate) fn check(&self) -> Result<()> {
        if let Self::Marked(format) = self
            && *format != FORMAT
        {
            bail!(
                "this setup repository uses format {format}; upgrade mise (this version supports format {FORMAT})"
            );
        }
        Ok(())
    }
}

pub(crate) fn detect(repo: &HistoryRepo, upstream: Option<&str>) -> Result<RepoState> {
    let Some(commit) = upstream else {
        return Ok(RepoState::Empty);
    };
    match repo.object_at(commit, MARKER_PATH)? {
        Some((_, oid)) => Ok(RepoState::Marked(parse_marker(
            &repo.cat_object_bounded(&oid, 64 * 1024)?,
        )?)),
        None => Ok(RepoState::Unmarked),
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn marker_round_trips() {
        assert_eq!(parse_marker(marker_content().as_bytes()).unwrap(), FORMAT);
        assert!(RepoState::Marked(FORMAT).check().is_ok());
        let err = RepoState::Marked(99).check().unwrap_err().to_string();
        assert!(err.contains("format 99"), "{err}");
        assert!(err.contains("upgrade mise"), "{err}");
        assert!(RepoState::Unmarked.check().is_ok());
    }
}