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

# semantic_release.version.declarations.toml module

class semantic_release.version.declarations.toml.TomlVersionDeclaration(path: Path | str, search_text: str, stamp_format: VersionStampType)

  Bases: `IVersionReplacer`

  property content: str

    A cached property that stores the content of the configured source file.

  classmethod from_string_definition(replacement_def: str) → TomlVersionDeclaration

    create an instance of self from a string representing one item of the “version_toml” list in the configuration

  parse() → set[Version]

    Look for the version in the source content

    Deprecated since version 9.20.0: Function is unused and will be removed in a future release

  replace(new_version: Version) → str

    Replace the version in the source content with new_version, and return the updated content.

  update_file_w_version(new_version: Version, noop: bool = False) → Path | None

    This method reads the underlying file, replaces each occurrence of the matched pattern, then writes the updated file.

    Parameters:

      new_version – The new version number as a Version instance