Source code for semantic_release.changelog.compare

from typing import Optional

from ..settings import config
from ..vcs_helpers import get_formatted_tag, get_repository_owner_and_name


[docs]def get_github_compare_url(from_version: str, to_version: str) -> str: """ Get the GitHub comparison link between two version tags. :param from_version: The older version to compare. :param to_version: The newer version to compare. :return: Link to view a comparison between the two versions. """ owner, name = get_repository_owner_and_name() return ( f"https://github.com/{owner}/{name}/compare/" f"{get_formatted_tag(from_version)}...{get_formatted_tag(to_version)}" )
[docs]def compare_url(version: str, previous_version: str = None, **kwargs) -> Optional[str]: if config.get("hvcs").lower() == "github" and previous_version: compare_url = get_github_compare_url(previous_version, version) return f"**[See all commits in this version]({compare_url})**" return None