generate_changelog.release_hint.RuleProcessor

RuleProcessor#

class generate_changelog.release_hint.RuleProcessor[source]#

Process a commit through all the rules and return the suggestion.

Parameters:

rule_list (List[dict]) – The list of dictionaries representing release rules

__init__(rule_list)[source]#
Parameters:

rule_list (List[dict]) –

__call__(commit, current_branch)[source]#

Return the result of applying all the rules to a commit.

Parameters:
  • commit (CommitContext) – The commit context to apply rules to

  • current_branch (str) – The name of the current branch

Return type:

Optional[str]

Returns:

The release hint