liboxen 0.9.4-beta3

Oxen is a fast, unstructured data version control, to help version datasets, written in Rust.
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

//! # oxen commit
//!
//! Commit the staged data
//!

use crate::api;
use crate::command;
use crate::error;
use crate::error::OxenError;
use crate::model::{Commit, LocalRepository};

/// # Commit the staged files in the repo
///
/// ```
/// use liboxen::command;
/// use liboxen::util;
/// # use liboxen::test;
/// # use liboxen::error::OxenError;
/// # use std::path::Path;
/// # fn main() -> Result<(), OxenError> {
/// # test::init_test_env();
///
/// // Initialize the repository
/// let base_dir = Path::new("repo_dir_commit");
/// let repo = command::init(base_dir)?;
///
/// // Write file to disk
/// let hello_file = base_dir.join("hello.txt");
/// util::fs::write_to_path(&hello_file, "Hello World");
///
/// // Stage the file
/// command::add(&repo, &hello_file)?;
///
/// // Commit staged
/// command::commit(&repo, "My commit message")?;
///
/// # util::fs::remove_dir_all(base_dir)?;
/// # Ok(())
/// # }
/// ```
pub fn commit(repo: &LocalRepository, message: &str) -> Result<Commit, OxenError> {
    let status = command::status(repo)?;
    if !status.has_added_entries() && status.staged_schemas.is_empty() {
        return Err(OxenError::NothingToCommit(
            error::string_error::StringError::new(
                r"No files are staged, not committing.
Stage a file or directory with `oxen add <file>`"
                    .to_string(),
            ),
        ));
    }
    let commit = api::local::commits::commit(repo, &status, message)?;
    log::info!("DONE COMMITTING in command::commit {}", commit);
    Ok(commit)
}