Struct PackageConfig 

pub struct PackageConfig {

    pub name: String,
    pub workspace_root: String,
    pub path: String,
    pub release_type: Option<ReleaseType>,
    pub tag_prefix: Option<String>,
    pub sub_packages: Option<Vec<SubPackage>>,
    pub prerelease: Option<PrereleaseConfig>,
    pub auto_start_next: Option<bool>,
    pub additional_paths: Option<Vec<String>>,
    pub additional_manifest_files: Option<Vec<AdditionalManifestSpec>>,
    pub breaking_always_increment_major: Option<bool>,
    pub features_always_increment_minor: Option<bool>,
    pub custom_major_increment_regex: Option<String>,
    pub custom_minor_increment_regex: Option<String>,
}

Package configuration for multi-package repositories and monorepos

Fields

name: String

Name for this package (default derived from path if not provided). For proper manifest version file updates this should match the canonical name field in the release_type manifest file. i.e. name = “…” in Cargo.toml or “name”: “…” in package.json

workspace_root: String

Path to the workspace root directory for this package relative to the repository root

path: String

Path to package directory relative to workspace_root

release_type: Option<ReleaseType>

ReleaseType type for determining which version files to update

tag_prefix: Option<String>

Git tag prefix for this package (e.g., “v” or “api-v”)

sub_packages: Option<Vec<SubPackage>>

Groups sub-packages under a single release. Each will share changelog, tag, and release, but will receive independent manifest version updates according to their type

prerelease: Option<PrereleaseConfig>

Optional prerelease configuration that overrides global settings

auto_start_next: Option<bool>

Auto starts next release for this package by performing a patch version update to version files and pushing a “chore” commit to the base_branch

additional_paths: Option<Vec<String>>

Additional directory paths to include commits from

additional_manifest_files: Option<Vec<AdditionalManifestSpec>>

Additional paths to generic version manifest files to update. Paths must be relative to the package path. Accepts either simple string paths or full config objects with custom regex patterns.

breaking_always_increment_major: Option<bool>

Always increments major version on breaking commits

features_always_increment_minor: Option<bool>

Always increments minor version on feature commits

custom_major_increment_regex: Option<String>

Custom regex pattern matched against commit messages to trigger a major version bump. This is additive — breaking change commits always trigger major bumps regardless of this setting. In TOML double-quoted strings, escape backslashes (e.g. "\\[BREAKING\\]" matches [BREAKING]).

custom_minor_increment_regex: Option<String>

Custom regex pattern matched against commit messages to trigger a minor version bump. This is additive — feat: commits always trigger minor bumps regardless of this setting. In TOML double-quoted strings, escape backslashes (e.g. "\\[FEATURE\\]" matches [FEATURE]).

Implementations

impl PackageConfig

pub fn tag_prefix(&self) -> Result<String>

Trait Implementations

impl Clone for PackageConfig

fn clone(&self) -> PackageConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PackageConfig

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

Formats the value using the given formatter.

impl Default for PackageConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PackageConfig

where PackageConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&SubPackage> for PackageConfig

fn from(value: &SubPackage) -> Self

Converts to this type from the input type.

impl From<SubPackage> for PackageConfig

fn from(value: SubPackage) -> Self

Converts to this type from the input type.

impl JsonSchema for PackageConfig

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for PackageConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.