orhun/git-cliff
1
1
Fork 0
mirror of https://github.com/orhun/git-cliff.git synced 2024-12-16 00:33:06 +03:00
Code Issues Projects Releases Wiki Activity
A highly customizable Changelog Generator that follows Conventional Commit specifications ⛰️
145 Commits 22 Branches 117 Tags 37 MiB
Rust 89.6%
TypeScript 5.3%
JavaScript 2.3%
Nix 0.7%
Dockerfile 0.6%
Other 1.5%
f95fca966b
Go to file
orhun f95fca966b
revert: chore(config): update template to include commit ids 
This reverts commit e3d3482191.
2021-06-20 00:27:13 +03:00
.github chore(cd): fix setting the release body 2021-06-19 23:19:03 +03:00
git-cliff feat(args): add --output argument 2021-06-18 19:41:08 +03:00
git-cliff-core fix(test): use default tag_pattern for tests 2021-06-18 03:04:35 +03:00
.dockerignore chore(docker): add Dockerfile 2021-06-11 21:41:03 +03:00
.editorconfig Initial commit 2021-05-11 01:54:45 +03:00
.gitignore chore(project): rename 2021-05-30 01:45:03 +03:00
Cargo.lock chore(dep): remove default features from git2 2021-06-11 20:27:18 +03:00
Cargo.toml chore(project): rename 2021-05-30 01:45:03 +03:00
CHANGELOG.md chore(release): prepare for v0.1.0-rc.3 2021-06-20 00:21:51 +03:00
cliff.toml revert: chore(config): update template to include commit ids 2021-06-20 00:27:13 +03:00
CODE_OF_CONDUCT.md chore(project): rename 2021-05-30 01:45:03 +03:00
codecov.yml chore(project): add codecov.yml 2021-06-07 03:14:06 +03:00
Dockerfile chore(docker): remove user directive from Dockerfile 2021-06-18 02:20:08 +03:00
LICENSE Initial commit 2021-05-11 01:54:45 +03:00
README.md feat(args): add --output argument 2021-06-18 19:41:08 +03:00
release.sh fix(release): strip the unreleased title from tag message 2021-06-19 23:51:44 +03:00
rustfmt.toml chore(fmt): remove normalize_comments from rustfmt.toml 2021-06-04 03:11:15 +03:00

README.md


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