semantic_release.changelog package

semantic_release.changelog.markdown_changelog(owner: str, repo_name: str, version: str, changelog: dict, header: bool = False, previous_version: str = None) str[source]

Generate a markdown version of the changelog.

Parameters:
  • owner – The repo owner.

  • repo_name – The repo name.

  • version – A string with the version number.

  • previous_version – A string with the last version number, to use for the comparison URL. If omitted, the URL will not be included.

  • changelog – A parsed changelog dict from generate_changelog.

  • header – A boolean that decides whether a version number header should be included.

Returns:

The markdown formatted changelog.

Submodules