generate_changelog.actions.metadata.ParseConventionalCommit

ParseConventionalCommit#

class generate_changelog.actions.metadata.ParseConventionalCommit[source]#

Parse a line of text using the conventional commit syntax.

The metadata will contain commit_type, a string and scopes, an empty list or a list of strings.

If a breaking change is indicated (with the !), metadata will also contain has_breaking_change set to True.

The description is returned for further processing.

If the summary does not match a conventional commit, the whole line is returned.

__init__(commit_metadata)[source]#
Parameters:

commit_metadata (Callable) –

__call__(message)[source]#

Parse a line of text using the conventional commit syntax.

Parameters:

message (str) – The commit message

Return type:

str

Returns:

The description for later processing.