gbp.rpm.policy.RpmPkgPolicy.ChangelogEntryFormatter(object)
class documentationgbp.rpm.policy.RpmPkgPolicy
(View In Hierarchy)
Helper class for generating changelog entries from git commits
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. |
Parse and filter out bug tracking system related meta tags from commit message. @param lines: commit message @type lines: C{list} of C{str} @param meta_tags: meta tags to look for @type meta_tags: C{tuple} of C{str} @return: bts-ids per meta tag and the non-mathced lines @rtype: (C{dict}, C{list} of C{str})
Filter out specific lines from the commit message. @param lines: commit message @type lines: C{list} of C{str} @param ignore_re: regexp for matching ignored lines @type ignore_re: C{str} @return: filtered commit message @rtype: C{list} of C{str}
Generate a changelog entry from a git commit. @param commit_info: info about the commit @type commit_info: C{commit_info} object from L{gbp.git.repository.GitRepository.get_commit_info()}. @param kwargs: additional arguments to the compose() method, currently we recognize 'full', 'id_len' and 'ignore_re' @type kwargs: C{dict} @return: formatted changelog entry @rtype: C{list} of C{str}