Skip to content

A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️

License

Apache-2.0, MIT licenses found

Licenses found

Apache-2.0
LICENSE-APACHE
MIT
LICENSE-MIT
Notifications You must be signed in to change notification settings

orhun/git-cliff

Folders and files

NameName
Last commit message
Last commit date

Latest commit

66dfbf4 · Jun 19, 2021
Jun 19, 2021
Jun 18, 2021
Jun 18, 2021
Jun 11, 2021
May 10, 2021
May 29, 2021
Jun 14, 2021
May 29, 2021
Jun 11, 2021
May 29, 2021
Jun 17, 2021
May 10, 2021
Jun 18, 2021
Jun 14, 2021
Jun 7, 2021
Jun 16, 2021
Jun 4, 2021

Repository files navigation


Installation

Usage

git-cliff [FLAGS] [OPTIONS] [RANGE]

Flags:

-v, --verbose       Increases the logging verbosity
-l, --latest        Processes the commits starting from the latest tag
-u, --unreleased    Processes the commits that do not belong to a tag
-h, --help          Prints help information
-V, --version       Prints version information

Options:

-c, --config <PATH>        Sets the configuration file [env: CONFIG=]  [default: cliff.toml]
-w, --workdir <PATH>       Sets the working directory [env: WORKDIR=]
-r, --repository <PATH>    Sets the repository to parse commits from [env: REPOSITORY=]
-p, --changelog <PATH>     Prepends entries to the given changelog file [env: CHANGELOG=]
-o, --output <PATH>        Writes output to the given file [env: OUTPUT=]
-t, --tag <TAG>            Sets the tag for the latest version [env: TAG=]
-s, --strip <PART>         Strips the given parts from the changelog [possible values: header, footer, all]

Args:

<RANGE>    Sets the commit range to process

Docker

The easiest way of running git-cliff (in the git root directory) is to use the available tags from Docker Hub:

docker run -t -v "$(pwd)":/app/ orhunp/git-cliff:latest

Or you can use the image from the GitHub Package Registry:

docker run -t -v "$(pwd)":/app/ docker.pkg.github.com/orhun/git-cliff/git-cliff:latest

Also, you can build the image yourself using docker build -t git-cliff . command.

Examples

License

GNU General Public License (v3.0)

Copyright

Copyright © 2021, git-cliff contributors