File-based release (recommended)#
setuptools-git-versioning can be used only within:
git repo, which means a
.gitsubfolder should exist in the repo root folder
branch with at least one tag
Otherwise it will be impossible to get project version based on the git repo commits,
setuptools-git-versioning will return version number
0.0.1 (or other value set up by starting_version).
But one or all of these requirements cannot be satisfied in the following cases:
Downloading source tarball without
Shallow repo clone without tags (#75).
Getting version number from a branch which does not contain any tags (Git-flow and its derivatives)
To avoid getting meaningless version number prefer using versioning schema described below.