Struct release_plz_core::PackageUpdateConfig

pub struct PackageUpdateConfig {
    pub generic: UpdateConfig,
    pub changelog_path: Option<Utf8PathBuf>,
    pub changelog_include: Vec<String>,
}

Package-specific config

Fields

generic: UpdateConfig

config that can be applied by default to all packages.

changelog_path: Option<Utf8PathBuf>

The changelog path can only be specified for a single package. I.e. it cannot be applied to [workspace] configuration. This path needs to be a relative path to the Cargo.toml of the project. I.e. if you have a workspace, it needs to be relative to the workspace root.

changelog_include: Vec<String>

List of package names. Include the changelogs of these packages in the changelog of the current package.

Implementations

impl PackageUpdateConfig

pub fn semver_check(&self) -> bool

pub fn should_update_changelog(&self) -> bool

Trait Implementations

impl Clone for PackageUpdateConfig

fn clone(&self) -> PackageUpdateConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PackageUpdateConfig

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

Formats the value using the given formatter.

impl Default for PackageUpdateConfig

fn default() -> PackageUpdateConfig

Returns the “default value” for a type.

impl From<UpdateConfig> for PackageUpdateConfig

fn from(config: UpdateConfig) -> Self

Converts to this type from the input type.

impl PartialEq for PackageUpdateConfig

fn eq(&self, other: &PackageUpdateConfig) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for PackageUpdateConfig

impl StructuralPartialEq for PackageUpdateConfig