Helper class for generating changelog entries from git commits

Class Variable max_entry_line_length Undocumented
Class Variable bts_meta_tags Undocumented
Class Variable bug_id_re Undocumented
Class Method compose Generate a changelog entry from a git commit.
Class Method _parse_bts_tags Parse and filter out bug tracking system related meta tags from commit message.
Class Method _extra_filter Filter out specific lines from the commit message.
max_entry_line_length =
Undocumented
(type: int)
bts_meta_tags =
Undocumented
(type: Tuple[str, ...])
bug_id_re =
Undocumented
(type: str)
@classmethod
def _parse_bts_tags(cls, lines, meta_tags):

Parse and filter out bug tracking system related meta tags from commit message.

Parameterslinescommit message (type: list of str)
meta_tagsmeta tags to look for (type: tuple of str)
Returnsbts-ids per meta tag and the non-mathced lines (type: (dict, list of str))
@classmethod
def _extra_filter(cls, lines, ignore_re):

Filter out specific lines from the commit message.

Parameterslinescommit message (type: list of str)
ignore_reregexp for matching ignored lines (type: str)
Returnsfiltered commit message (type: list of str)
@classmethod
def compose(cls, commit_info, **kwargs):

Generate a changelog entry from a git commit.

Parameterscommit_infoinfo about the commit (type: commit_info object from gbp.git.repository.GitRepository.get_commit_info().)
kwargsadditional arguments to the compose() method, currently we recognize 'full', 'id_len' and 'ignore_re' (type: dict)
Returnsformatted changelog entry (type: list of str)
API Documentation for git-buildpackage, generated by pydoctor at 2021-02-01 08:15:22.