Struct git_cliff_core::changelog::Changelog

pub struct Changelog<'a> {
    pub releases: Vec<Release<'a>>,
    /* private fields */
}

Changelog generator.

Fields

releases: Vec<Release<'a>>

Releases that the changelog will contain.

Implementations

impl<'a> Changelog<'a>

pub fn new(releases: Vec<Release<'a>>, config: &'a Config) -> Result<Self>

Constructs a new instance.

pub fn bump_version(&mut self) -> Result<Option<String>>

Increments the version for the unreleased changes based on semver.

pub fn generate<W: Write>(&self, out: &mut W) -> Result<()>

Generates the changelog and writes it to the given output.

pub fn prepend<W: Write>(&self, changelog: String, out: &mut W) -> Result<()>

Generates a changelog and prepends it to the given changelog.

pub fn write_context<W: Write>(&self, out: &mut W) -> Result<()>

Prints the changelog context to the given output.

Trait Implementations

impl<'a> Debug for Changelog<'a>

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

Formats the value using the given formatter.