Struct git_cliff_core::config::GitConfig

pub struct GitConfig {

    pub conventional_commits: Option<bool>,
    pub filter_unconventional: Option<bool>,
    pub split_commits: Option<bool>,
    pub commit_preprocessors: Option<Vec<CommitPreprocessor>>,
    pub commit_parsers: Option<Vec<CommitParser>>,
    pub protect_breaking_commits: Option<bool>,
    pub link_parsers: Option<Vec<LinkParser>>,
    pub filter_commits: Option<bool>,
    pub tag_pattern: Option<String>,
    pub skip_tags: Option<Regex>,
    pub ignore_tags: Option<Regex>,
    pub topo_order: Option<bool>,
    pub sort_commits: Option<String>,
    pub limit_commits: Option<usize>,
}

Git configuration

Fields

conventional_commits: Option<bool>

Whether to enable parsing conventional commits.

filter_unconventional: Option<bool>

Whether to filter out unconventional commits.

split_commits: Option<bool>

Whether to split commits by line, processing each line as an individual commit.

commit_preprocessors: Option<Vec<CommitPreprocessor>>

Git commit preprocessors.

commit_parsers: Option<Vec<CommitParser>>

Git commit parsers.

protect_breaking_commits: Option<bool>

Whether to protect all breaking changes from being skipped by a commit parser.

link_parsers: Option<Vec<LinkParser>>

Link parsers.

filter_commits: Option<bool>

Whether to filter out commits.

tag_pattern: Option<String>

Blob pattern for git tags.

skip_tags: Option<Regex>

Regex to skip matched tags.

ignore_tags: Option<Regex>

Regex to ignore matched tags.

topo_order: Option<bool>

Whether to sort tags topologically.

sort_commits: Option<String>

Sorting of the commits inside sections.

limit_commits: Option<usize>

Limit the number of commits included in the changelog.

Trait Implementations

impl Clone for GitConfig

fn clone(&self) -> GitConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GitConfig

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

Formats the value using the given formatter.

impl Default for GitConfig

fn default() -> GitConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GitConfig

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

Deserialize this value from the given Serde deserializer.

impl Serialize for GitConfig

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

Serialize this value into the given Serde serializer.