generate_changelog.templating.render_changelog

render_changelog#

generate_changelog.templating.render_changelog(version_context, config, incremental=False)[source]#

Render the full or incremental changelog for the repository to a string.

Parameters:

  • version_context (List[VersionContext]) – The processed commits

  • config (Configuration) – The current configuration object.

  • incremental (bool) – True to generate an incremental changelog. False to render the entire thing.

Return type:

RenderedChangelog

Returns:

The full or partial changelog