Struct Config

pub struct Config {
    pub commit: CommitConfig,
    pub version: VersioningConfig,
    pub changelog: ChangelogConfig,
    pub release: ReleaseConfig,
}

Configuration

Fields

commit: CommitConfig

Commit configuration

version: VersioningConfig

Versioning configuration

changelog: ChangelogConfig

Changelog configuration

release: ReleaseConfig

Release configuration

Implementations

impl Config

pub fn load_from_fs(cwd: &Path) -> Result<Option<Self>, Error>

Loads the configuration from a file system

The configuration is looked into the parent git repo.

pub fn save_to_fs(&self, cwd: &Path, overwrite: bool) -> Result<(), Error>

Saves the file to the file system

The file is saved relative to the workdir of the parent git repo.

pub fn to_toml(&self) -> Result<String, Error>

Returns the TOML representation of the configuration

pub fn to_yaml(&self) -> Result<String, Error>

Returns the YAML representation of the configuration

Trait Implementations

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.