Struct ReleaseConfig 

pub struct ReleaseConfig {

    pub branches: Vec<String>,
    pub tag_prefix: String,
    pub commit_pattern: String,
    pub breaking_section: String,
    pub misc_section: String,
    pub types: Vec<CommitType>,
    pub changelog: ChangelogConfig,
    pub version_files: Vec<String>,
    pub version_files_strict: bool,
    pub artifacts: Vec<String>,
    pub floating_tags: bool,
    pub build_command: Option<String>,
    pub stage_files: Vec<String>,
    pub prerelease: Option<String>,
    pub pre_release_command: Option<String>,
    pub post_release_command: Option<String>,
    pub sign_tags: bool,
    pub draft: bool,
    pub release_name_template: Option<String>,
    pub hooks: HooksConfig,
    pub packages: Vec<PackageConfig>,
    pub path_filter: Option<String>,
}

Fields

branches: Vec<String>

tag_prefix: String

commit_pattern: String

breaking_section: String

misc_section: String

types: Vec<CommitType>

changelog: ChangelogConfig

version_files: Vec<String>

version_files_strict: bool

artifacts: Vec<String>

floating_tags: bool

build_command: Option<String>

stage_files: Vec<String>

Additional files/globs to stage after build_command runs (e.g. Cargo.lock).

prerelease: Option<String>

Pre-release identifier (e.g. “alpha”, “beta”, “rc”). When set, versions are formatted as X.Y.Z-.N where N auto-increments.

pre_release_command: Option<String>

Shell command to run before the release starts (validation, checks).

post_release_command: Option<String>

Shell command to run after the release completes (notifications, deployments).

sign_tags: bool

Sign annotated tags with GPG/SSH (git tag -s).

draft: bool

Create GitHub releases as drafts (requires manual publishing).

release_name_template: Option<String>

Minijinja template for the GitHub release name. Available variables: version, tag_name, tag_prefix. Default when None: uses the tag name (e.g. “v1.2.0”).

hooks: HooksConfig

Git hooks configuration.

packages: Vec<PackageConfig>

Monorepo packages. When non-empty, each package is released independently.

path_filter: Option<String>

Internal: set when resolving a package config. Commits are filtered to this path.

Implementations

impl ReleaseConfig

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

Find the first config file that exists in the given directory. Returns (path, is_legacy).

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 release config by merging package overrides with root config.

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

Find a package by name. Returns an error if the package is not found.

Trait Implementations

impl Clone for ReleaseConfig

fn clone(&self) -> ReleaseConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReleaseConfig

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

Formats the value using the given formatter.

impl Default for ReleaseConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ReleaseConfig

where ReleaseConfig: 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 ReleaseConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.