mirror of
https://github.com/orhun/git-cliff.git
synced 2024-09-11 15:05:30 +03:00
A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️
changelogchangelog-generatorcommitconventional-changelogconventional-commitsgeneratorhacktoberfestkeepachangelogrustsemverstarred-orhun-repostarred-repo
.github | ||
git-cliff | ||
git-cliff-core | ||
.dockerignore | ||
.editorconfig | ||
.gitignore | ||
Cargo.lock | ||
Cargo.toml | ||
CHANGELOG.md | ||
cliff.toml | ||
CODE_OF_CONDUCT.md | ||
codecov.yml | ||
Dockerfile | ||
LICENSE | ||
README.md | ||
release.sh | ||
rustfmt.toml |
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=]
-b, --body <TEMPLATE> Sets the template for the changelog body [env: TEMPLATE=]
-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