git_changelog¶
Bases: Tool
__call__(
*args: str,
bump: _Value = ...,
bump_latest: _Flag = ...,
bumped_version: _Flag = ...,
config_file: _Value = ...,
convention: _Value = ...,
debug_info: _Flag = ...,
filter_commits: _Value = ...,
in_place: _Flag = ...,
include_all: _Flag = ...,
input: _Value = ...,
jinja_context: _Value = ...,
marker_line: _Value = ...,
no_zerover: _Flag = ...,
omit_empty_versions: _Flag = ...,
output: _Value = ...,
parse_refs: _Flag = ...,
provider: _Value = ...,
release_notes: _Flag = ...,
sections: _Value = ...,
template: _Value = ...,
trailers: _Flag = ...,
version_regex: _Value = ...,
versioning: _Value = ...,
**flags: Any,
) -> Result
[-s SECTIONS][-a] [-t TEMPLATE][-T] [-E][-Z] [-F RANGE][-j KEY=VALUE] [-V][--debug-info]
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
bump
|
_Value
|
Specify the bump from latest version for the set of unreleased commits. |
...
|
bump_latest
|
_Flag
|
Deprecated, use --bump=auto instead. |
...
|
bumped_version
|
_Flag
|
Show bumped version and exit. |
...
|
config_file
|
_Value
|
Configuration file(s). May be repeated: a list emits the flag once per item. |
...
|
convention
|
_Value
|
The commit convention to match against. |
...
|
debug_info
|
_Flag
|
Print debug information. |
...
|
filter_commits
|
_Value
|
The Git revision-range filter to use (e.g. |
...
|
in_place
|
_Flag
|
Insert new entries (versions missing from changelog) in-place. |
...
|
include_all
|
_Flag
|
Include all commits, even those without a recognized type. |
...
|
input
|
_Value
|
Read from given file when creating release notes. |
...
|
jinja_context
|
_Value
|
Pass additional key/value pairs to the template. May be repeated: a list emits the flag once per item. |
...
|
marker_line
|
_Value
|
A marker line at which to insert new entries (versions missing from changelog). |
...
|
no_zerover
|
_Flag
|
By default, breaking changes on a 0.x don't bump the major version, maintaining it at 0. |
...
|
omit_empty_versions
|
_Flag
|
Omit empty versions from the output. |
...
|
output
|
_Value
|
Output to given file. |
...
|
parse_refs
|
_Flag
|
Parse provider-specific references in commit messages (GitHub/GitLab/Bitbucket issues, PRs, etc.). |
...
|
provider
|
_Value
|
Explicitly specify the repository provider. |
...
|
release_notes
|
_Flag
|
Output release notes to stdout based on the last entry in the changelog. |
...
|
sections
|
_Value
|
A comma-separated list of sections to render. |
...
|
template
|
_Value
|
The Jinja2 template to use. |
...
|
trailers
|
_Flag
|
Parse Git trailers in the commit message. |
...
|
version_regex
|
_Value
|
A regular expression to match versions in the existing changelog (used to find the latest release) when writing in-place. |
...
|
versioning
|
_Value
|
Versioning scheme to use when bumping and comparing versions. |
...
|