generate_changelog.context.CommitContext

CommitContext#

class generate_changelog.context.CommitContext[source]#

Commit information for the template context.

sha: str#

The full hex SHA of the commit.

commit_datetime: datetime#

The date and time of the commit with timezone offset.

summary: str#

The first line of the commit message.

body: str#

The commit message sans the first line.

committer: str#

The name and email of the committer as name <email@ex.com>.

grouping: tuple#

The values to group this commit based on the group_by configuration.

metadata: dict#

Metadata for this commit parsed from the commit message.

files: set#

The file paths (relative to the repository root) modified by this commit.

__post_init__()[source]#

Set the cached author information to None.

property short_sha: str#

The first seven characters of the hex sha.

property authors: list#

A list of authors’ names and emails.

Returns:

A list of dictionaries with name and email keys.

property author_names: list#

A list of the authors’ names.

__init__(sha, commit_datetime, summary, body, committer, grouping=<factory>, metadata=<factory>, files=<factory>)#
Parameters:
Return type:

None