Skip to content

fix(scm-provider): prefer full version over floating tags #2116

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
woile merged 1 commit into from
Oct 24, 2026
Merged

fix(scm-provider): prefer full version over floating tags #2116

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion commitizen/providers/scm_provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,13 @@ def get_version(self) -> str:
rules = TagRules.from_settings(self.config.settings)
tags = get_tags(reachable_only=True)
version_tags = rules.get_version_tags(tags)
version = max((rules.extract_version(t) for t in version_tags), default=None)
# Floating tags (e.g. `v1.0` next to `v1.0.0`) compare equal. Among equal
# versions, prefer the most specific (longest) spelling.
version = max(
(rules.extract_version(t) for t in version_tags),
key=lambda v: (v, len(str(v))),
default=None,
)
return str(version) if version is not None else "0.0.0"

def set_version(self, version: str) -> None:
Expand Down
20 changes: 20 additions & 0 deletions tests/providers/test_scm_provider.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,3 +140,23 @@ def test_scm_provider_detect_legacy_tags(config: BaseConfig, util: UtilFixture):
util.create_file_and_commit("test: fake commit")
util.create_tag("v0.5.0")
assert provider.get_version() == "0.5.0"


@pytest.mark.usefixtures("tmp_git_project")
def test_scm_provider_prefers_full_version_over_floating_tags(
config: BaseConfig, util: UtilFixture
):
"""Floating tags (`v1.0`, `v1`) must not hide the full `v1.0.0` version."""
# Arrange
util.create_file_and_commit("feat: initial commit")
util.create_tag("v1.0.0")
util.create_tag("v1.0")
util.create_tag("v1")
config.settings["version_provider"] = "scm"
config.settings["tag_format"] = "v$version"

# Act
provider = get_provider(config)

# Assert
assert provider.get_version() == "1.0.0"
Loading