Crate git_cliff_core

A highly customizable changelog generator ⛰️

The crate provides a set of optional features that can be enabled in your Cargo.toml file.

Features

• repo (enabled by default) — Enable parsing commits from a git repository. You can turn this off if you already have the commits to put in the changelog and you don’t need git-cliff to parse them.
• github — Enable integration with GitHub. You can turn this off if you don’t use GitHub and don’t want to make network requests to the GitHub API.
• gitlab — Enable integration with GitLab. You can turn this off if you don’t use GitLab and don’t want to make network requests to the GitLab API.
• bitbucket — Enable integration with Bitbucket. You can turn this off if you don’t use Bitbucket and don’t want to make network requests to the Bitbucket API.

Modules

• changelog
  Changelog generator.
• command
  Command runner.
• commit
  Git commit.
• config
  Config file parser.
• embed
  Embedded file handler.
• error
  Error handling.
• release
  Common release type.
• remotegithub or gitlab or bitbucket
  Remote handler.
• reporepo
  Git repository.
• template
  Template engine.

Constants

• DEFAULT_CONFIG
  Default configuration file.
• DEFAULT_OUTPUT
  Default output file.
• IGNORE_FILE
  Default ignore file.