semantic_release.version.declarations.pattern module¶
- class semantic_release.version.declarations.pattern.PatternVersionDeclaration(path: Path | str, search_text: str, stamp_format: VersionStampType)[source]¶
Bases:
IVersionReplacer
VersionDeclarationABC implementation representing a version number in a particular file. The version number is identified by a regular expression, which should be provided in search_text.
- property content: str¶
A cached property that stores the content of the configured source file.
- classmethod from_string_definition(replacement_def: str, tag_format: str) PatternVersionDeclaration [source]¶
create an instance of self from a string representing one item of the “version_variables” list in the configuration
- parse() set[Version] [source]¶
Return the versions matching this pattern. Because a pattern can match in multiple places, this method returns a set of matches. Generally, there should only be one element in this set (i.e. even if the version is specified in multiple places, it should be the same version in each place), but it falls on the caller to check for this condition.
Deprecated since version 9.20.0: Function is unused and will be removed in a future release