Struct GitConfig

pub struct GitConfig {

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

Git configuration

Fields

conventional_commits: bool

Parse commits according to the conventional commits specification.

require_conventional: bool

Require all commits to be conventional. Takes precedence over filter_unconventional.

filter_unconventional: bool

Exclude commits that do not match the conventional commits specification from the changelog.

split_commits: bool

Split commits on newlines, treating each line as an individual commit.

commit_preprocessors: Vec<TextProcessor>

An array of regex based parsers to modify commit messages prior to further processing.

commit_parsers: Vec<CommitParser>

An array of regex based parsers for extracting data from the commit message.

protect_breaking_commits: bool

Prevent commits having the BREAKING CHANGE: footer from being excluded by commit parsers.

link_parsers: Vec<LinkParser>

An array of regex based parsers to extract links from the commit message and add them to the commit’s context.

filter_commits: bool

Exclude commits that are not matched by any commit parser.

tag_pattern: Option<Regex>

Regex to select git tags that represent releases.

skip_tags: Option<Regex>

Regex to select git tags that do not represent proper releases.

ignore_tags: Option<Regex>

Regex to exclude git tags after applying the tag_pattern.

count_tags: Option<Regex>

Regex to count matched tags.

use_branch_tags: bool

Include only the tags that belong to the current branch.

topo_order: bool

Order releases topologically instead of chronologically.

topo_order_commits: bool

Order commits chronologically instead of topologically.

sort_commits: String

How to order commits in each group/release within the changelog.

limit_commits: Option<usize>

Limit the total number of commits included in the changelog.

recurse_submodules: Option<bool>

Read submodule commits.

Trait Implementations

impl Clone for GitConfig

fn clone(&self) -> GitConfig

Returns a duplicate 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.