ScmVersion is wrong if two tags are on the same git-commit

[jenisys]

If two tags are assigned to the same git-commit, setuptools-scm seems to get confused (especially if the secondary tag contains digits or ends with digits).

How to repeat

• Use a python-project repository that uses setuptools-scm

# -- BASH SHELL (or similar):
$ git tag v1.2.3
$ python -msetuptools_scm
1.2.3
# OR: 1.2.4.dev0+gd... - If DIRTY

# -- CASE: Secondary tag with digits -- SYNDROME HERE
$ git tag BASELINE_D2024-10-03
$ python -msetuptools_scm
3

# -- CASE: Secondary tag without any digits -- OK
# CLEANUP: First remove last secondary tag.
$ git tag --delete BASELINE_D2024-10-03
$ git tag BASELINE
$ python -msetuptools_scm
1.2.3
# OR: 1.2.4.dev0+gd... - If DIRTY

RELATED:

• Issue Configuration to exclude/rewrite tag names? #1072

[RonnyPfannschmidt]

i think theres a need to fail very hard in that case, its nonsensical and confusin

[jenisys]

RESOLVED:
Provide a specific git_describe_command in pyproject-toml to select the git-tag(s) that are of interest and exclude others that are not.

# -- FILE: pyproject.toml
# ...

# -- GIT-TAG MATCHER: Only use tags like: "v1.2.3"
[tool.setuptools_scm]
git_describe_command = "git describe --match 'v*'"

BUT: Documentation could be improved

• There is a very short description, but without explanation/example why it is needed
• SEE: https://setuptools-scm.readthedocs.io/en/latest/config/#configuration-parameters