Skip to content

git_cliff

git-cliff documentation

footman._stubs.git_cliff.GitCliff

Bases: Tool

__call__ 

__call__(
    *args: 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: Literal["oldest", "newest"]
    | Sequence[Literal["oldest", "newest"]]
    | None = ...,
    strip: Literal["header", "footer", "all"]
    | Sequence[Literal["header", "footer", "all"]]
    | 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,
) -> Result

git-cliff 2.13.1

Parameters:

Name Type Description Default
azure_devops_repo _Value

Sets the Azure DevOps repository.

 ...
azure_devops_token _Value

Sets the Azure DevOps API token.

 ...
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 cliff.toml.

 ...
config_url _Value

Sets the URL for the configuration file.

 ...
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.

 ...
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.

 ...
sort Literal['oldest', 'newest'] | Sequence[Literal['oldest', 'newest']] | None

Sets sorting of the commits inside sections. Defaults to oldest.

 ...
strip Literal['header', 'footer', 'all'] | Sequence[Literal['header', 'footer', 'all']] | 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.

 ...
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.

 ...