Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
View this page
Toggle table of contents sidebar

# semantic_release.cli.changelog_writer module

semantic_release.cli.changelog_writer.apply_user_changelog_template_directory(template_dir: Path, environment: Environment, destination_dir: Path, noop: bool = False) → list[str]

semantic_release.cli.changelog_writer.generate_release_notes(hvcs_client: HvcsBase, release: Release, template_dir: Path, history: ReleaseHistory, style: str, mask_initial_release: bool, license_name: str = '') → str

semantic_release.cli.changelog_writer.get_default_tpl_dir(style: str, sub_dir: str | None = None) → Path

semantic_release.cli.changelog_writer.render_default_changelog_file(output_format: ChangelogOutputFormat, changelog_context: ChangelogContext, changelog_style: str) → str

semantic_release.cli.changelog_writer.render_release_notes(release_notes_template_file: str, template_env: Environment) → str

semantic_release.cli.changelog_writer.write_changelog_files(runtime_ctx: RuntimeContext, release_history: ReleaseHistory, hvcs_client: HvcsBase, noop: bool = False) → list[str]

semantic_release.cli.changelog_writer.write_default_changelog(changelog_file: Path, destination_dir: Path, output_format: ChangelogOutputFormat, changelog_context: ChangelogContext, changelog_style: str, noop: bool = False) → str