Struct git_checks::checks::Changelog

pub struct Changelog { /* fields omitted */ }

Check for changelog modifications.

This checks to make sure that a changelog entry has been added (or modified) in every commit or topic.

Methods

impl Changelog

pub fn new(style: ChangelogStyle) -> Self

Create a new changelog check.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

pub fn required(&mut self, required: bool) -> &mut Self

Whether changelog entries are required or not.

Trait Implementations

impl Debug for Changelog

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

Formats the value using the given formatter.

impl ContentCheck for Changelog

fn name(&self) -> &str

The name of the check.

fn check(&self, _: &CheckGitContext, content: &Content) -> Result<CheckResult>

Run the check.