Struct Config 

pub struct Config {
    pub commit: CommitConfig,
    pub release: ReleaseConfig,
    pub hooks: HooksConfig,
    pub packages: Vec<PackageConfig>,
}

Root configuration. Three top-level concerns:

• commit — how commits are parsed
• release — how releases are cut
• hooks — what runs at each lifecycle event

commit:
  types: [...]
  pattern: '...'

release:
  branches: [main]
  tag_prefix: "v"
  version_files: [Cargo.toml]
  channels:
    canary: { prerelease: canary }
    stable: {}

hooks:
  pre_commit: ["cargo fmt --check"]
  pre_release: ["cargo test --workspace"]

Fields

commit: CommitConfig

release: ReleaseConfig

hooks: HooksConfig

packages: Vec<PackageConfig>

Monorepo packages.

Implementations

impl Config

pub fn find_config(dir: &Path) -> Option<(PathBuf, bool)>

Find the first config file that exists in the given directory.

pub fn load(path: &Path) -> Result<Self, ReleaseError>

Load config from a YAML file. Falls back to defaults if the file doesn’t exist.

pub fn resolve_package(&self, pkg: &PackageConfig) -> Self

Resolve a package into a full config by merging package overrides.

pub fn resolve_fixed(&self) -> Self

Resolve all packages for fixed versioning mode.

pub fn resolve_channel(&self, name: &str) -> Result<Self, ReleaseError>

Resolve a named release channel.

pub fn find_package(&self, name: &str) -> Result<&PackageConfig, ReleaseError>

Find a package by name.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

where Config: Default,

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.