revert to full setuptools-git-versioning in toml file

This commit is contained in:
cclecle
2023-03-19 18:42:24 +00:00
parent d7fbf52647
commit 3e130e6bdf
3 changed files with 7 additions and 4 deletions

View File

@@ -82,6 +82,7 @@ Get the last found version in the repository [return formated string]:
print(f"most recent repository version: {gitversionhelper.version.getLastVersion(formated_output=True)}")
Others kwargs available to this function:
* version_std: string to force a version standard for rendering ["PEP440" or "SemVer"]
* same_branch: boolean to force searching on same branch
* ignore_unknown_tags: boolean to allow unknown tag to be ignored
@@ -95,6 +96,7 @@ Or with formated output:
print(f"current repository version: {gitversionhelper.version.getCurrentVersion(formated_output=True)}")
kwargs available to this function:
* All same args as getLastVersion()
* bump_type: if version need to be pump, allow to configure next release update type: major, minor, patch, dev
* bump_dev_strategy: if bump_type is dev, allow to choose dev update strategy: post, pre-patch, pre-minor, pre-major
@@ -112,6 +114,7 @@ kwargs available to those function:
## Limitations
There is unfortunately some technical limitation :
* MultiThreading and async behavior is not tested.
* Multiple tag on the same commit is not supported.
* Branch filter when searching for a version is only tested with -no-ff strategy