diff --git a/docs-static/usage.md b/docs-static/usage.md index 18b1cdb..bd8ed28 100644 --- a/docs-static/usage.md +++ b/docs-static/usage.md @@ -82,18 +82,18 @@ Get the last found version in the repository [return formated string]: print(f"most recent repository version: {gitversionhelper.tag.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 +* 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 Get the current version of the repository, automatically bump it if the last one is not tagged [returns MetaVersion object]: print(f"most recent repository version: {gitversionhelper.tag.getCurrentVersion()}") 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 +* 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 A version object can also be manually formated: @@ -108,6 +108,6 @@ 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 \ No newline at end of file +* 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 \ No newline at end of file