bumpversion 0.0.9

Update all version strings in your project and optionally commit and tag the changes
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

//! Version control integration layer.
//!
//! Defines the `VersionControlSystem` trait and related data structures
//! for interacting with git and other VCS backends.
pub mod git;

#[cfg(test)]
/// Test utilities for VCS interactions.
pub mod temp;

use crate::f_string::PythonFormatString;
use std::future::Future;
use std::path::{Path, PathBuf};

/// Information about the latest VCS tag, including version and commit data.
#[derive(Debug, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct TagInfo {
    /// Whether the repository contains dirty files
    pub dirty: bool,
    /// The current commit SHA hash.
    pub commit_sha: String,
    /// The distance to the latest tag.
    pub distance_to_latest_tag: usize,
    /// The current tag.
    pub current_tag: String,
    /// The current version.
    pub current_version: String,
}

/// Information about the current VCS revision (branch, repository root).
#[derive(Debug, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct RevisionInfo {
    /// The name of the current branch.
    pub branch_name: String,
    /// The short branch name.
    ///
    /// Consists of 20 lowercase characters of the branch name with special characters removed.
    pub short_branch_name: String,
    /// The root directory of the repository.
    pub repository_root: PathBuf,
}

/// Combined container for both optional `TagInfo` and `RevisionInfo`.
#[derive(Debug, Clone, Default, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct TagAndRevision {
    /// The current tag information.
    pub tag: Option<TagInfo>,
    /// The latest revision.
    pub revision: Option<RevisionInfo>,
}

/// Abstract interface for version control systems.
///
/// Implementors can open repositories, add/commit files, tag releases, and query history.
pub trait VersionControlSystem {
    /// Error type returned by this VCS implementation.
    type Error: std::error::Error + Send + Sync + 'static;

    /// Open the VCS repository at the given path.
    fn open(path: impl Into<PathBuf>) -> Result<Self, Self::Error>
    where
        Self: Sized;

    /// Return the root path of the repository.
    fn path(&self) -> &Path;

    /// Stage a set of files for commit.
    fn add<P>(
        &self,
        files: impl IntoIterator<Item = P>,
    ) -> impl Future<Output = Result<(), Self::Error>>
    where
        P: AsRef<std::ffi::OsStr>;

    /// Create a commit with the given message and environment.
    fn commit<A, E, AS, EK, EV>(
        &self,
        message: &str,
        extra_args: A,
        env: E,
    ) -> impl Future<Output = Result<(), Self::Error>>
    where
        A: IntoIterator<Item = AS>,
        E: IntoIterator<Item = (EK, EV)>,
        AS: AsRef<std::ffi::OsStr>,
        EK: AsRef<std::ffi::OsStr>,
        EV: AsRef<std::ffi::OsStr>;

    /// Create a new tag (annotated or lightweight) in the repository.
    fn tag(
        &self,
        name: &str,
        message: Option<&str>,
        sign: bool,
    ) -> impl Future<Output = Result<(), Self::Error>>;

    /// List all tags in the repository.
    fn tags(&self) -> impl Future<Output = Result<Vec<String>, Self::Error>>;

    /// List files with uncommitted changes.
    fn dirty_files(&self) -> impl Future<Output = Result<Vec<PathBuf>, Self::Error>>;

    /// Retrieve combined tag and revision metadata using the given templates.
    fn latest_tag_and_revision(
        &self,
        tag_name: &PythonFormatString,
        parse_version_regex: &regex::Regex,
    ) -> impl Future<Output = Result<TagAndRevision, Self::Error>>;
}