generate_changelog.context.ChangelogContext

ChangelogContext

class generate_changelog.context.ChangelogContext

The primary context used when rendering a changelog.

__init__(config, versions=<factory>)

Parameters:

• config (Configuration) –

• versions (List[VersionContext]) –

Return type:

None

config: Configuration

The changelog generation configuration.

versions: List[VersionContext]

The version contexts to render in the changelog.

unreleased_label: str

The configured label used as the version title of the changes since the last valid tag.

valid_author_tokens: List[str]

The configured tokens in git commit trailers that indicate authorship.

group_by: List[str]

The configured grouping aspects for commits within a version.

group_depth: int

The number of levels version commits are grouped by.

diff_index: Callable

as_dict()

Safely generate a dict version of this object.

Return type:

dict