Struct unclog::Changelog

pub struct Changelog {
    pub maybe_unreleased: Option<ChangeSet>,
    pub releases: Vec<Release>,
    pub prologue: Option<String>,
    pub epilogue: Option<String>,
}

A log of changes for a specific project.

Fields

maybe_unreleased: Option<ChangeSet>

Unreleased changes don’t have version information associated with them.

releases: Vec<Release>

An ordered list of releases’ changes.

prologue: Option<String>

Any additional content that must appear at the beginning of the changelog.

epilogue: Option<String>

Any additional content that must appear at the end of the changelog (e.g. historical changelog content prior to switching to unclog).

Implementations

impl Changelog

pub fn is_empty(&self) -> bool

Checks whether this changelog is empty.

pub fn render_all(&self, config: &Config) -> String

Renders the full changelog to a string.

pub fn render_released(&self, config: &Config) -> String

Renders all released versions’ entries, excluding unreleased ones.

pub fn render_unreleased(&self, config: &Config) -> Result<String>

Renders just the unreleased changes to a string.

pub fn init_dir<P: AsRef<Path>, R: AsRef<Path>, E: AsRef<Path>>( config: &Config, path: P, maybe_prologue_path: Option<R>, maybe_epilogue_path: Option<E> ) -> Result<()>

Initialize a new (empty) changelog in the given path.

Creates the target folder if it doesn’t exist, and optionally copies an epilogue into it.

pub fn generate_config<P, Q, S>( config_path: P, path: Q, remote: S, force: bool ) -> Result<()>

where P: AsRef<Path>, Q: AsRef<Path>, S: AsRef<str>,

Attempts to generate a configuration file for the changelog in the given path, inferring as many parameters as possible from its environment.

pub fn read_from_dir<P>(config: &Config, path: P) -> Result<Self>

where P: AsRef<Path>,

Attempt to read a full changelog from the given directory.

pub fn add_unreleased_entry<P, S, C, I, O>( config: &Config, path: P, section: S, maybe_component: Option<C>, id: I, content: O ) -> Result<()>

where P: AsRef<Path>, S: AsRef<str>, C: AsRef<str>, I: AsRef<str>, O: AsRef<str>,

Adds a changelog entry with the given ID to the specified section in the unreleased folder.

pub fn add_unreleased_entry_from_template( config: &Config, path: &Path, section: &str, component: Option<String>, id: &str, platform_id: PlatformId, message: &str ) -> Result<()>

Attempts to add an unreleased changelog entry from the given parameters, rendering them through the change template specified in the configuration file.

The change template is assumed to be in Handlebars format.

pub fn render_unreleased_entry_from_template( config: &Config, path: &Path, section: &str, component: Option<String>, id: &str, platform_id: PlatformId, message: &str ) -> Result<String>

Renders an unreleased changelog entry from the given parameters to a string, making use of the change template specified in the configuration file.

The change template is assumed to be in Handlebars format.

pub fn get_entry_path<P, R, S, C, I>( config: &Config, path: P, release: R, section: S, component: Option<C>, id: I ) -> PathBuf

where P: AsRef<Path>, R: AsRef<str>, S: AsRef<str>, C: AsRef<str>, I: AsRef<str>,

Compute the file system path to the entry with the given parameters.

pub fn prepare_release_dir<P: AsRef<Path>, S: AsRef<str>>( config: &Config, path: P, version: S ) -> Result<()>

Moves the unreleased folder from our changelog to a directory whose name is the given version.

pub fn entries(&self) -> ChangelogEntryIter<'_>

Facilitates iteration through all entries in this changelog, producing EntryPath instances such that one can trace the full path to each entry. The order in which entries are produced is the order in which they will be rendered if the changelog is built.

pub fn find_duplicates_across_releases( &self ) -> Vec<(EntryPath<'_>, EntryPath<'_>)>

Returns a list of entries that are the same across releases within this changelog. Effectively compares just the entries themselves without regard for the release, section, component, etc.

Trait Implementations

impl Clone for Changelog

fn clone(&self) -> Changelog

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Changelog

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

Formats the value using the given formatter.

impl Hash for Changelog

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Changelog

fn eq(&self, other: &Changelog) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Changelog

impl StructuralPartialEq for Changelog