git_cliff¶
Bases: Tool[_R]
__call__(
*args: str | PathLike[str],
azure_devops_repo: Value = ...,
azure_devops_token: Value = ...,
bitbucket_repo: Value = ...,
bitbucket_token: Value = ...,
body: Value = ...,
bump: Value = ...,
bumped_version: Flag = ...,
config: Value = ...,
config_url: Value = ...,
context: Flag = ...,
count_tags: Value = ...,
current: Flag = ...,
exclude_path: Value = ...,
from_context: Value = ...,
gitea_repo: Value = ...,
gitea_token: Value = ...,
github_repo: Value = ...,
github_token: Value = ...,
gitlab_repo: Value = ...,
gitlab_token: Value = ...,
ignore_tags: Value = ...,
include_path: Value = ...,
init: Value = ...,
latest: Flag = ...,
no_exec: Flag = ...,
offline: Flag = ...,
output: Value = ...,
prepend: Value = ...,
repository: Value = ...,
skip_commit: Value = ...,
skip_tags: Value = ...,
sort: Sort | Sequence[Sort] | None = ...,
strip: Strip | Sequence[Strip] | None = ...,
tag: Value = ...,
tag_pattern: Value = ...,
topo_order: Flag = ...,
unreleased: Flag = ...,
use_branch_tags: Flag = ...,
use_native_tls: Flag = ...,
verbose: Flag = ...,
with_commit: Value = ...,
with_tag_message: Value = ...,
workdir: Value = ...,
**flags: Any,
) -> _R
A highly customizable changelog generator ⛰️
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
azure_devops_repo
|
Value
|
Sets the Azure DevOps repository. Added in 2.11.0. |
...
|
azure_devops_token
|
Value
|
Sets the Azure DevOps API token. Added in 2.11.0. |
...
|
bitbucket_repo
|
Value
|
Sets the Bitbucket repository. |
...
|
bitbucket_token
|
Value
|
Sets the Bitbucket API token. |
...
|
body
|
Value
|
Sets the template for the changelog body. |
...
|
bump
|
Value
|
Bumps the version for unreleased changes. |
...
|
bumped_version
|
Flag
|
Prints bumped version for unreleased changes. |
...
|
config
|
Value
|
Sets the configuration file. Defaults to |
...
|
config_url
|
Value
|
Sets the URL for the configuration file. Added in 2.9.1. |
...
|
context
|
Flag
|
Prints changelog context as JSON. |
...
|
count_tags
|
Value
|
Sets the tags to count in the changelog. |
...
|
current
|
Flag
|
Processes the commits that belong to the current tag. |
...
|
exclude_path
|
Value
|
Sets the path to exclude related commits. May be repeated: a list emits the flag once per item. |
...
|
from_context
|
Value
|
Generates changelog from a JSON context. |
...
|
gitea_repo
|
Value
|
Sets the Gitea repository. |
...
|
gitea_token
|
Value
|
Sets the Gitea API token. |
...
|
github_repo
|
Value
|
Sets the GitHub repository. |
...
|
github_token
|
Value
|
Sets the GitHub API token. |
...
|
gitlab_repo
|
Value
|
Sets the GitLab repository. |
...
|
gitlab_token
|
Value
|
Sets the GitLab API token. |
...
|
ignore_tags
|
Value
|
Sets the tags to ignore in the changelog. |
...
|
include_path
|
Value
|
Sets the path to include related commits. May be repeated: a list emits the flag once per item. |
...
|
init
|
Value
|
Writes the default configuration file to cliff.toml. |
...
|
latest
|
Flag
|
Processes the commits starting from the latest tag. |
...
|
no_exec
|
Flag
|
Disables the external command execution. |
...
|
offline
|
Flag
|
Disable network access for remote repositories. Added in 2.12.0. |
...
|
output
|
Value
|
Writes output to the given file. |
...
|
prepend
|
Value
|
Prepends entries to the given changelog file. |
...
|
repository
|
Value
|
Sets the git repository. May be repeated: a list emits the flag once per item. |
...
|
skip_commit
|
Value
|
Sets commits that will be skipped in the changelog. May be repeated: a list emits the flag once per item. |
...
|
skip_tags
|
Value
|
Sets the tags to skip in the changelog. Added in 2.12.0. |
...
|
sort
|
Sort | Sequence[Sort] | None
|
Sets sorting of the commits inside sections. Defaults to |
...
|
strip
|
Strip | Sequence[Strip] | None
|
Strips the given parts from the changelog. |
...
|
tag
|
Value
|
Sets the tag for the latest version. |
...
|
tag_pattern
|
Value
|
Sets the regex for matching git tags. |
...
|
topo_order
|
Flag
|
Sorts the tags topologically. |
...
|
unreleased
|
Flag
|
Processes the commits that do not belong to a tag. |
...
|
use_branch_tags
|
Flag
|
Include only the tags that belong to the current branch. |
...
|
use_native_tls
|
Flag
|
Load TLS certificates from the native certificate store. Added in 2.8.0. |
...
|
verbose
|
Flag
|
Increases the logging verbosity. |
...
|
with_commit
|
Value
|
Sets custom commit messages to include in the changelog. May be repeated: a list emits the flag once per item. |
...
|
with_tag_message
|
Value
|
Sets custom message for the latest release. |
...
|
workdir
|
Value
|
Sets the working directory. |
...
|