semantic_release.changelog.release_history module

class semantic_release.changelog.release_history.Release

Bases: TypedDict

committer: ForwardRef('Actor', module='semantic_release.changelog.release_history', owner=<class 'semantic_release.changelog.release_history.Release'>)

elements: ForwardRef('dict[str, list[ParseResult]]', module='semantic_release.changelog.release_history', owner=<class 'semantic_release.changelog.release_history.Release'>)

tagged_date: ForwardRef('datetime', module='semantic_release.changelog.release_history', owner=<class 'semantic_release.changelog.release_history.Release'>)

tagger: ForwardRef('Actor', module='semantic_release.changelog.release_history', owner=<class 'semantic_release.changelog.release_history.Release'>)

version: ForwardRef('Version', module='semantic_release.changelog.release_history', owner=<class 'semantic_release.changelog.release_history.Release'>)

class semantic_release.changelog.release_history.ReleaseHistory(unreleased: dict[str, list[ParseResult]], released: dict[Version, Release])

Bases: object

classmethod from_git_history(repo: Repo, translator: VersionTranslator, commit_parser: CommitParser[ParseResult, ParserOptions], exclude_commit_patterns: Iterable[Pattern[str]] = ()) → ReleaseHistory

release(version: Version, tagger: Actor, committer: Actor, tagged_date: datetime) → ReleaseHistory