git_changelog¶
GitChangelog ¶
Bases: Tool[_R]
Methods:
| Name | Description |
|---|---|
__call__ |
Automatic Changelog generator using Jinja2 templates. |
Attributes:
| Name | Type | Description |
|---|---|---|
argv |
GitChangelog[Argv]
|
|
__call__ ¶
__call__(*args: str | PathLike[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) -> _R
Automatic Changelog generator using Jinja2 templates.
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. |
...
|