git_cliff_core/
lib.rs

1//! A highly customizable changelog generator ⛰️
2//!
3//! The crate provides a set of optional features that can be enabled in your
4//! `Cargo.toml` file.
5//!
6//! ## Features
7#![cfg_attr(feature = "document-features", doc = document_features::document_features!())]
8#![cfg_attr(docsrs, feature(doc_auto_cfg))]
9#![warn(missing_docs, clippy::unwrap_used)]
10#![doc(
11    html_logo_url = "https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/img/git-cliff.png",
12    html_favicon_url = "https://raw.githubusercontent.com/orhun/git-cliff/main/website/static/favicon/favicon.ico"
13)]
14
15/// Changelog generator.
16pub mod changelog;
17/// Command runner.
18pub mod command;
19/// Git commit.
20pub mod commit;
21/// Config file parser.
22pub mod config;
23/// Remote contributor.
24pub mod contributor;
25/// Embedded file handler.
26pub mod embed;
27/// Error handling.
28pub mod error;
29/// Common release type.
30pub mod release;
31/// Remote handler.
32#[cfg(feature = "remote")]
33#[allow(async_fn_in_trait)]
34pub mod remote;
35/// Git repository.
36#[cfg(feature = "repo")]
37pub mod repo;
38/// Release statistics.
39pub mod statistics;
40/// Git tag.
41pub mod tag;
42/// Template engine.
43pub mod template;
44
45#[macro_use]
46extern crate log;
47
48/// Default configuration file.
49pub const DEFAULT_CONFIG: &str = "cliff.toml";
50/// Default output file.
51pub const DEFAULT_OUTPUT: &str = "CHANGELOG.md";
52/// Default ignore file.
53pub const IGNORE_FILE: &str = ".cliffignore";