-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: add verbose logging to git-cliff
- Loading branch information
Showing
2 changed files
with
42 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,41 @@ | ||
git-cliff 2.2.1 | ||
git-cliff contributors <[email protected]> | ||
A highly customizable changelog generator ⛰️ | ||
|
||
Usage: | ||
git-cliff [FLAGS] [OPTIONS] [--] [RANGE] | ||
|
||
FLAGS: | ||
-h, --help Prints help information | ||
-V, --version Prints version information | ||
-v, --verbose... Increases the logging verbosity | ||
--bump Bumps the version for unreleased changes | ||
--bumped-version Prints bumped version for unreleased changes | ||
-l, --latest Processes the commits starting from the latest tag | ||
--current Processes the commits that belong to the current tag | ||
-u, --unreleased Processes the commits that do not belong to a tag | ||
--topo-order Sorts the tags topologically | ||
--no-exec Disables the external command execution | ||
-x, --context Prints changelog context as JSON | ||
|
||
OPTIONS: | ||
-i, --init [<CONFIG>] Writes the default configuration file to cliff.toml | ||
-c, --config <PATH> Sets the configuration file [env: GIT_CLIFF_CONFIG=] [default: cliff.toml] | ||
-w, --workdir <PATH> Sets the working directory [env: GIT_CLIFF_WORKDIR=] | ||
-r, --repository <PATH>... Sets the git repository [env: GIT_CLIFF_REPOSITORY=] | ||
--include-path <PATTERN>... Sets the path to include related commits [env: GIT_CLIFF_INCLUDE_PATH=] | ||
--exclude-path <PATTERN>... Sets the path to exclude related commits [env: GIT_CLIFF_EXCLUDE_PATH=] | ||
--tag-pattern <PATTERN> Sets the regex for matching git tags [env: GIT_CLIFF_TAG_PATTERN=] | ||
--with-commit <MSG>... Sets custom commit messages to include in the changelog [env: GIT_CLIFF_WITH_COMMIT=] | ||
--skip-commit <SHA1>... Sets commits that will be skipped in the changelog [env: GIT_CLIFF_SKIP_COMMIT=] | ||
-p, --prepend <PATH> Prepends entries to the given changelog file [env: GIT_CLIFF_PREPEND=] | ||
-o, --output [<PATH>] Writes output to the given file [env: GIT_CLIFF_OUTPUT=] | ||
-t, --tag <TAG> Sets the tag for the latest version [env: GIT_CLIFF_TAG=] | ||
-b, --body <TEMPLATE> Sets the template for the changelog body [env: GIT_CLIFF_TEMPLATE=] | ||
-s, --strip <PART> Strips the given parts from the changelog [possible values: header, footer, all] | ||
--sort <SORT> Sets sorting of the commits inside sections [default: oldest] [possible values: oldest, newest] | ||
--github-token <TOKEN> Sets the GitHub API token [env: GITHUB_TOKEN] | ||
--github-repo <OWNER/REPO> Sets the GitHub repository [env: GITHUB_REPO=] | ||
|
||
ARGS: | ||
[RANGE] Sets the commit range to process |