proj_flow.log.rich_text.api

The proj_flow.log.rich_text.api defines base types for CHANGELOG.md manipulation.

class proj_flow.log.rich_text.api.FileUpdate(setup: LogSetup, commit_date: str)

commit_date: str

class proj_flow.log.rich_text.api.ChangelogGenerator

property filename: str

abstract property formatter: Type[FileUpdate]

abstract property ext: str

abstract property split_re: str

property intro_head: str

property intro_text: str

abstract main_heading(caption: str) → List[str]

abstract para(text: str) → List[str]

intro()

format_changelog(log: Dict[str, List[Link]], setup: LogSetup, rt: Runtime)

create_changelog(tags: List[str], git: Git, links: Hosting, rt: Runtime, scope_fix: Dict[str, str] = {}, take_all: bool = False)

update_changelog(log: Dict[str, List[Link]], setup: LogSetup, rt: Runtime)