generate_changelog.configuration.Configuration

Configuration#

class generate_changelog.configuration.Configuration[source]#

Configuration options for generate-changelog.

variables: dict#

User variables for reference in other parts of the configuration.

starting_tag_pipeline: Optional[list]#

Pipeline to find the most recent tag for incremental changelog generation. Leave empty to always start at first commit.

unreleased_label: str = 'Unreleased'#

Used as the version title of the changes since the last valid tag.

summary_pipeline: list#

Process the commit’s first line for use in the changelog.

body_pipeline: list#

Process the commit’s body for use in the changelog.

output_pipeline: list#

Process and store the full or partial changelog.

template_dirs: list#

Full or relative paths to look for output generation templates.

group_by: list#

Group the commits within a version by these commit attributes.

__init__(variables=<factory>, starting_tag_pipeline=<factory>, unreleased_label='Unreleased', summary_pipeline=<factory>, body_pipeline=<factory>, output_pipeline=<factory>, template_dirs=<factory>, group_by=<factory>, tag_pattern='^[0-9]+\\\\.[0-9]+(?:\\\\.[0-9]+)?$', include_merges=False, ignore_patterns=<factory>, commit_classifiers=<factory>, valid_author_tokens=<factory>, release_hint_rules=<factory>)#
Parameters:

  • variables (dict) –

  • starting_tag_pipeline (list | None) –

  • unreleased_label (str) –

  • summary_pipeline (list) –

  • body_pipeline (list) –

  • output_pipeline (list) –

  • template_dirs (list) –

  • group_by (list) –

  • tag_pattern (str) –

  • include_merges (bool) –

  • ignore_patterns (list) –

  • commit_classifiers (list) –

  • valid_author_tokens (list) –

  • release_hint_rules (list) –

Return type:

None

tag_pattern: str = '^[0-9]+\\.[0-9]+(?:\\.[0-9]+)?$'#

Only tags matching this regular expression are used for the changelog.

include_merges: bool = False#

Tells git-log whether to include merge commits in the log.

ignore_patterns: list#

Ignore commits whose summary line matches any of these regular expression patterns.

commit_classifiers: list#

Set the commit’s category metadata to the first classifier that returns True.

valid_author_tokens: list#

Tokens in git commit trailers that indicate authorship.

release_hint_rules: list#

Rules applied to commits to determine the type of release to suggest.

property rendered_variables: dict#

Render each variable value using the previous variables as the context.

update_from_file(filename)[source]#

Updates this configuration instance in place from a YAML file.

Parameters:

filename (Path) – Path to the YAML file

Raises:

Exit – if the path does not exist or is a directory

Return type:

None