Skip to main content

BaseConfig

Struct BaseConfig 

Source
pub struct BaseConfig {
    pub commit: Option<CommitConfig>,
    pub branch: Option<BranchConfig>,
    pub pr: Option<PrConfig>,
    pub check: Option<CheckConfig>,
    pub push: Option<PushConfig>,
    pub versioning: Option<VersioningConfig>,
    pub changelog: Option<ChangelogConfig>,
    pub release: Option<ReleaseConfig>,
    pub hooks: Option<HooksConfig>,
    pub ai: Option<AiConfig>,
    pub registry: Option<RegistryConfig>,
    pub registries: Option<HashMap<String, NamedRegistryConfig>>,
}

Fields§

§commit: Option<CommitConfig>§branch: Option<BranchConfig>§pr: Option<PrConfig>§check: Option<CheckConfig>§push: Option<PushConfig>§versioning: Option<VersioningConfig>§changelog: Option<ChangelogConfig>§release: Option<ReleaseConfig>§hooks: Option<HooksConfig>§ai: Option<AiConfig>§registry: Option<RegistryConfig>§registries: Option<HashMap<String, NamedRegistryConfig>>

Implementations§

Source§

impl BaseConfig

Source

pub fn empty() -> Self

Source

pub fn merge(self, lower: BaseConfig) -> BaseConfig

Merge two configs. self has higher priority — its sections win over lower for each top-level section, falling back to lower only when self’s section is None.

Source

pub fn minimal() -> Self

Source

pub fn standard() -> Self

Source

pub fn full() -> Self

Source

pub fn version(&self) -> u32

Source

pub fn commit_subject_max_length(&self) -> u32

Source

pub fn commit_use_emojis(&self) -> bool

Source

pub fn commit_types(&self) -> BTreeMap<String, CommitTypeConfig>

Source

pub fn commit_scopes_mode(&self) -> ScopeMode

Source

pub fn commit_scope_restrict_to_defined(&self) -> bool

Source

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

Source

pub fn commit_breaking_require_header(&self) -> bool

Source

pub fn commit_breaking_emoji(&self) -> Option<String>

Source

pub fn commit_breaking_emoji_mode(&self) -> EmojiMode

Source

pub fn commit_ticket_required(&self) -> bool

Source

pub fn commit_ticket_pattern(&self) -> Option<String>

Source

pub fn commit_ticket_source(&self) -> TicketSource

Source

pub fn commit_protected_allow(&self) -> bool

Source

pub fn commit_protected_force(&self) -> bool

Source

pub fn commit_protected_warn(&self) -> bool

Source

pub fn branch_remote(&self) -> String

Source

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

Source

pub fn branch_naming_pattern(&self) -> String

Source

pub fn branch_naming_enforce(&self) -> bool

Source

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

Source

pub fn pr_enabled(&self) -> bool

Source

pub fn check_require_conventional(&self) -> bool

Source

pub fn check_commits_enabled(&self) -> bool

Source

pub fn check_commits_enforce_on(&self) -> CommitEnforcementScope

Source

pub fn push_allow_protected(&self) -> bool

Source

pub fn push_allow_force(&self) -> bool

Source

pub fn push_check_commits(&self) -> bool

Source

pub fn push_check_branch_policy(&self) -> bool

Source

pub fn versioning_tag_prefix(&self) -> String

Source

pub fn changelog_output(&self) -> String

Source

pub fn changelog_format(&self) -> ChangelogFormat

Source

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

Source

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

Source

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

Source

pub fn changelog_show_scope(&self) -> bool

Source

pub fn changelog_show_empty_sections(&self) -> Option<bool>

Source

pub fn changelog_show_empty_scopes(&self) -> Option<bool>

Source

pub fn changelog_misc_section(&self) -> Option<String>

Source

pub fn changelog_header_use(&self) -> bool

Source

pub fn changelog_header_title(&self) -> String

Source

pub fn changelog_header_description(&self) -> Option<String>

Source

pub fn changelog_sections(&self) -> BTreeMap<String, ChangelogSectionConfig>

Source

pub fn changelog_unreleased_label(&self) -> String

Source

pub fn changelog_date_format(&self) -> Option<String>

Source

pub fn release_enabled(&self) -> bool

Source

pub fn release_source_branch(&self) -> String

Source

pub fn release_target_branch(&self) -> String

Source

pub fn release_branch_format(&self) -> String

Source

pub fn release_hotfix_pattern(&self) -> String

Source

pub fn release_require_clean_worktree(&self) -> bool

Source

pub fn release_fail_if_tag_exists(&self) -> bool

Source

pub fn release_fail_if_release_branch_exists(&self) -> bool

Source

pub fn release_finish_tag(&self) -> bool

Source

pub fn release_finish_push(&self) -> bool

Source

pub fn release_finish_backmerge_branch(&self) -> String

Source

pub fn hooks_pre_commit(&self) -> bool

Source

pub fn hooks_commit_msg(&self) -> bool

Source

pub fn hooks_pre_push(&self) -> bool

Source

pub fn ai_enabled(&self) -> bool

Source

pub fn ai_provider(&self) -> AiProvider

Source

pub fn ai_commit_enabled(&self) -> bool

Source

pub fn ai_changelog_enabled(&self) -> bool

Source

pub fn ai_release_prepare_enabled(&self) -> bool

Source

pub fn registry_use(&self) -> Option<String>

Source

pub fn registries_map(&self) -> HashMap<String, NamedRegistryConfig>

Trait Implementations§

Source§

impl Clone for BaseConfig

Source§

fn clone(&self) -> BaseConfig

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 BaseConfig

Source§

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

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

impl<'de> Deserialize<'de> for BaseConfig

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 BaseConfig

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> 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> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

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