Skip to main content

Config

Struct Config 

Source
pub struct Config {
    pub git: GitConfig,
    pub commit: CommitConfig,
    pub changelog: ChangelogConfig,
    pub channels: ChannelsConfig,
    pub vcs: VcsConfig,
    pub packages: Vec<PackageConfig>,
}
Expand description

Root configuration. Six top-level concerns:

  • git — tag prefix, floating tags, signing
  • commit — type→bump classification
  • changelog — file, template, groups
  • channels — branch→release mapping
  • vcs — provider-specific config
  • packages — version files, artifacts, hooks

Fields§

§git: GitConfig§commit: CommitConfig§changelog: ChangelogConfig§channels: ChannelsConfig§vcs: VcsConfig§packages: Vec<PackageConfig>

Implementations§

Source§

impl Config

Source

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

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

Source

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

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

Source

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

Resolve a named release channel, returning the channel config.

Source

pub fn default_channel(&self) -> Result<&ChannelConfig, ReleaseError>

Resolve the default channel.

Source

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

Find a package by path.

Source

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

Find a package by name (last component of path).

Source

pub fn tag_prefix_for(&self, pkg: &PackageConfig) -> String

Resolve effective tag prefix for a package.

Source

pub fn changelog_for<'a>( &'a self, pkg: &'a PackageConfig, ) -> &'a ChangelogConfig

Resolve effective changelog config for a package.

Source

pub fn version_files_for(&self, pkg: &PackageConfig) -> Vec<String>

Resolve effective version files for a package, with auto-detection.

Source

pub fn fixed_packages(&self) -> Vec<&PackageConfig>

Get all non-independent packages (for fixed versioning).

Source

pub fn independent_packages(&self) -> Vec<&PackageConfig>

Get all independent packages.

Source

pub fn all_artifacts(&self) -> Vec<String>

Collect all artifacts glob patterns from all packages.

Trait Implementations§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Config

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Config
where Config: Default,

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for Config

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,