Package gbp :: Package rpm :: Module policy :: Class RpmPkgPolicy :: Class ChangelogEntryFormatter
[hide private]
[frames] | no frames]

Class ChangelogEntryFormatter

object --+
         |
        RpmPkgPolicy.ChangelogEntryFormatter

Helper class for generating changelog entries from git commits

Instance Methods [hide private]

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Methods [hide private]
(dict, list of str)
_parse_bts_tags(cls, lines, meta_tags)
Parse and filter out bug tracking system related meta tags from commit message.
list of str
_extra_filter(cls, lines, ignore_re)
Filter out specific lines from the commit message.
list of str
compose(cls, commit_info, **kwargs)
Generate a changelog entry from a git commit.
Class Variables [hide private]
  max_entry_line_length = 76
  bug_id_re = '[A-Za-z0-9#_\\-]+'
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

_parse_bts_tags(cls, lines, meta_tags)
Class Method

 

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

Parameters:
  • lines (list of str) - commit message
  • meta_tags (str) - meta tags (regexp) to look for
Returns: (dict, list of str)
bts-ids per meta tag and the non-mathced lines

_extra_filter(cls, lines, ignore_re)
Class Method

 

Filter out specific lines from the commit message.

Parameters:
  • lines (list of str) - commit message
  • ignore_re (str) - regexp for matching ignored lines
Returns: list of str
filtered commit message

compose(cls, commit_info, **kwargs)
Class Method

 

Generate a changelog entry from a git commit.

Parameters:
Returns: list of str
formatted changelog entry